What I write

  • Setup and integration tutorials. A developer connects your product to a tool they already use and sees it work.
  • Build tutorials. A developer builds something small and real with your product, start to finish.
  • Framework guides. One task shown properly in one framework, with that framework's conventions.

How I write it

I build the project before I write a word. The tutorial is then a record of something that worked, in the order a developer would do it.

Every step shows its expected output. If the reader's screen doesn't match, they know which step to go back to.

What you get

You get a tutorial with code that ran, in your format, so your engineers review working code.

Work you can check

The Centus case study covers how those guides were reviewed.

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 tutorial 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.

My guide on how to write a technical tutorial is the method I follow, and it sits in the technical documentation topic. The quick start guide template is the short form of the same idea.

FAQ

What do technical tutorial writing services include?

A step-by-step guide built on a project I made and ran first, with the code and the expected output of each step.

How long does one tutorial take?

A draft takes about 5 days from an agreed brief and revisions take 2, so you can publish in one working week.

Do you write the code as well?

Yes. I build the example project before drafting, so the code in the tutorial has run.