I will write clear technical documentation for your code or API

Good code with bad documentation gets abandoned. Your users file issues the docs should have answered, and you answer the same question every week.

I read your actual code and write documentation that matches what it really does, rather than a generic template with your project name pasted in.

WHAT I WRITE

READMEs that get someone running in under five minutes. API reference covering every endpoint, parameter and error. Setup guides that work on a clean machine. Code examples that run as written. Troubleshooting sections for the failures people actually hit. Contributing guides and changelogs.

HOW I WORK

I read the source first. If the code and your description disagree, I tell you. That mismatch is usually a bug worth knowing about, and I have found a few.

FORMATS

Markdown, reStructuredText, OpenAPI and Swagger, MkDocs, Docusaurus, plain HTML.

WHAT YOU GET

Documentation that fits your repo, in your format, ready to commit. Source files included so you can maintain it yourself.

Send a repo link or your code and I will tell you what it actually needs.