What I write

  • Quickstarts. One path from a clean machine to a first working result, with the requirements stated before the first command.
  • Reference pages. The request, the response and the errors for each endpoint or command, checked against the running product.
  • Troubleshooting pages. What a developer sees when something fails, what caused it and what to do next.

How I write it

I run every command on the page before it goes to you. A step that fails for me would fail for your reader, so it gets fixed or explained before the draft exists.

Each step says what the reader should see when it works. That line is what lets a developer, or a coding agent, tell a working step from a broken one.

What you get

You get pages your engineers can review for accuracy without rewriting them, in your docs format.

Work you can check

I have no client documentation set I can link in public. The documentation I can show you is on this site, where each page ships with its test:

For Centus I wrote more than 50 developer guides for its blog, and its engineers approved them without a round of revisions.

How we'd work together

Email hello@ninadpathak.com with the product and the reader, or book a 30-minute call at https://zcal.co/ninadpathak/meet. This page lists no rate, so ask for a quote with the scope.

  1. We talk for 30 minutes about the reader and what the page has to do for them.
  2. You get a written brief and a timeline within 24 hours of that call.
  3. I need a demo account, API keys and an account with real data in it, because I run the product before I write about it.
  4. Once the brief is agreed, the first piece is a paid trial, and we carry on only if you're happy with it.
  5. A draft takes about 5 days from the brief and revisions take 2, so you can publish in one working week.
  6. There are two rounds of review at most.
  7. I deliver in Google Docs or as a Markdown pull request, or in whatever your team uses, and I can load it into your CMS if you'd like.

Once we've worked together for a while, the same cycle comes down to 4 days end to end.

The technical documentation topic holds my guides and templates in the order a team does the work. The piece on how developers judge devtools documentation covers what a buyer checks before a trial.

FAQ

What do developer documentation writing services include?

Quickstarts, reference pages and troubleshooting pages for a developer product, each written after running the product and delivered in your docs format.

Do you need access to the product?

Yes. I need a demo account, API keys and an account with real data in it, because every command on the page gets run before you see the draft.

Can you work in our docs repository?

Yes. I deliver as a Markdown pull request or in Google Docs, or in whatever your team uses.