Skip to main content

2 posts tagged with "technical writing"

View All Tags

I Built a CLI Tool That Writes Changelogs For You — Here's Why

· 6 min read
Faith Wachukwu
Documentation Engineer
I Built a CLI Tool That Writes Changelogs For You — Here's Why

Developers hate writing changelogs. Not because it's hard, but because it's boring. You already did the work, you wrote the code, you wrote the commit messages, you shipped the feature. Now someone wants you to write about it again, but prettier?

So most teams do one of three things: skip the changelog entirely, dump raw git log output into a file and call it done, or assign the task to whoever lost the last argument.

I decided to fix this with a Python CLI tool that reads your git history and uses AI to generate a clean, categorized, publish-ready changelog. One command. One file. Done. Here's the thinking behind it.

How to Write Documentation for Both Humans and AI Retrieval Systems

· 11 min read
Faith Wachukwu
Documentation Engineer
A hand-drawn style illustration showing a document in the center with two readers: a stick-figure human on the left reading the document from top to bottom, and a boxy robot on the right reaching in to grab a single highlighted chunk. Text reads: Your docs now have two readers. Write for both, compromise on neither.

Your documentation has a new reader, and it doesn't have eyes. AI tools like chatbots, IDE assistants, and Retrieval-Augmented Generation (RAG) systems now stand between your carefully written docs and the engineer who needs them. These tools chop your pages into chunks, search for relevant matches, and generate responses before a human ever visits the actual page.