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
some amount of duplication is always going to occur. But for the most part, linking liberally, arranging topics in a sensible way, and trying to adhere to a single source model is a good idea.
Andrew Etter • Modern Technical Writing
A good structure is something you can trust. It relieves you from the burden of remembering and keeping track of everything. If you can trust the system, you can let go of the attempt to hold everything together in your head and you can start focusing on what is important: The content, the argument and the ideas. By
Sönke Ahrens • How to Take Smart Notes: One Simple Technique to Boost Writing, Learning and Thinking
Why writing needs frameworks and structure
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 Writing 101: A Real-World Guide to Planning and Writing Technical Content
amazon.com
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
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
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
How to write complex software
grantslatton.com