Skip to main content

2 posts tagged with "documentation"

View All Tags

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.

Docs and Deployments: The Power of Clear Documentation in DevOps

· 5 min read
Faith Wachukwu
Documentation Engineer

DevOps is more than a methodology; it’s a culture that brings development and operations teams together to achieve shared goals: faster delivery, improved quality, and seamless collaboration. However, while automation, CI/CD pipelines, and cloud-native tooling receive all the hype, one crucial element is often overlooked: documentation.