Technologists write for other technologists. Which is perfectly acceptable – if that’s your market. If it isn’t, then the last person who should be documenting your product is the geek who developed it.
Why? Missing links. Gaps in understanding.
Developers and engineers assume that everyone knows the basics of their science. When they document their own work, they tend to focus on the esoteric, big-picture stuff. Those small, seemingly unimportant connective details go missing.
What happens next is a matter of simple arithmetic.
End users who can’t immediately master your product become confused and frustrated. Confused and frustrated end users force you to divert valuable resources away from new projects and into customer service. Therefore, bad documentation costs money.
Nervewerx specializes in good documentation.
We translate even the most turgid technical prose into concise, standards-driven, user-friendly help. We do this by putting your product through its paces, according to written or oral instructions provided by your techies. If there’s a logical gap – one of those forehead-slapping boners only the truly gifted make with style – we’ll find it and clearly explain it.
As we like to say, writing to form begins with WTF!
Technical Writing: Deliverables
- Installation and setup guides
- User and reference manuals
- Spec sheets
- SDK and API programming notes
- FAQs and other support documents
- Online and context-sensitive help systems
- Business and marketing plans
- Policy and procedure manuals
- Training materials
- PowerPoint presentations
Technical Writing: Formats
- MS Word documents
- Static or interactive PDFs
- Contextual help files and tool tips
- Mobile content
- Bound books and loose sheets