A how-to manual is judged by one thing: whether a reader who is slightly out of their depth can finish the task without opening a support ticket. That means tested steps, honest prerequisites, screenshots that show the button you actually need, and a troubleshooting page for the three places people get stuck.
What a manual includes
- Prerequisites and setup: versions, licences, hardware and access stated before step one, not discovered at step nine.
- Numbered procedures: one action per step, in the order a real user performs them, with the expected result after each block.
- Screenshots and callouts: annotated images placed where the interface confuses people, plus captions that survive being printed in black and white.
- Troubleshooting: symptom, cause, fix — the section that saves your support team the most time.
- Glossary and index: terms defined once, consistently, with an index for the reader who jumps straight to page 84.
How we write a tested manual
- Access and scope. You give us the tool, the account or the recording; we agree what the reader must be able to do at the end.
- Walkthrough. We perform every task ourselves and document what actually happens, including the error messages the documentation forgets.
- Drafting. Procedures written, screenshots annotated, cross-references checked.
- Technical review. Your engineer, trainer or support lead reviews for accuracy; we revise and deliver the finished guide plus a version log.
Manual formats
Software and SaaS user guides, onboarding handbooks, API and integration explainers, hardware setup manuals, compliance and safety procedures, internal runbooks, and training workbooks with exercises. For regulated or safety-critical material we write to your standard and mark every step that must not be paraphrased.
Who commissions these
SaaS teams whose help centre is a graveyard of 2019 articles. Manufacturers who need a manual in English before a shipment. Trainers turning a live workshop into a workbook. Founders writing the implementation guide that closes enterprise deals, because procurement asked for documentation and there wasn’t any.
How we test before we write
Every procedure is performed on a clean account or a fresh install, in the order the documentation presents it, with the state reset between attempts. If a step only works because of something installed earlier, that dependency is written into the prerequisites rather than hidden. Error messages are reproduced and quoted exactly, because a reader searching for the message they see on screen needs to find your page.
We also write for the reader who arrives mid-task: each procedure states what must already be true before step one, and every chapter ends with a short verification step so the reader knows it worked before moving on.
Pricing
| Tier | Scope | Price | Was | You save |
|---|---|---|---|---|
| Starter | 1 manual / guide | $330 | $345 | |
| Professional | 3 guides (product suite) | $900 | $900 | |
| Bulk / Authority | 5 guides | $1,300 | $1,300 |
Frequent questions
Do you test the software yourself?
Yes, on a sandbox or trial account you provide. Steps we could not reproduce are flagged rather than written from assumption.
Can you match our documentation style guide?
Yes. Send the guide and we will follow it — voice, capitalisation, code formatting, terminology and warning conventions.
What about updates?
Version two of a manual is priced lower than a new one because the structure and screenshots already exist. Ask for a maintenance quote with the first order.
Brief a manual — the product, the reader and the task they must complete are enough to quote.