Technical Writing
Learn everything about a subject. Write down exactly what an audience needs to know and no more. Make the content beautiful, discoverable, scannable, and searchable. Consider everything a draft, and iterate relentlessly. Make contribution simple.
Andrew Etter • Modern Technical Writing
Technical writers can be invaluable partners across the product development life cycle.
Kieran Morgan • Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
Focus on decisions, not tasks
technicalwriting.dev
Technical writers, first and foremost, are testers and researchers. Your job is to know what people want to achieve and precisely how to achieve it.
Andrew Etter • Modern Technical Writing
Improve predictability of technical writing projects.
Kieran Morgan • Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
Benefit of having the process in place
The process is intended to introduce formality, structure and predictability into technical documentation projects. This comes at an upfront cost, of course – it takes time to create Documentation Plans and Documentation Schedules. However, the benefits of adding structure quickly become apparent, as the project produces better quality deliverables
... See moreKieran Morgan • Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
Technical documents that are executed at a high level can enhance the overall value of the product or system as a whole, as well as accomplish the more mundane (but equally important) technical writing aims of explaining a product or process to its end users, reducing support calls, mitigating risks, and ticking the correct legal and regulatory box
... See moreKieran Morgan • Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
technical writing is a definable, repeatable, predictable process. It can be planned, scheduled and executed in a manner that leads to predictable outcomes, quality and timing.
Kieran Morgan • Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
