Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
Kieran Morganamazon.com
Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
Below each step is a set of activities that needs to be accomplished to complete the step. Below the activities are tools and outputs. Tools are the templates that you use to execute the activities, such as a Documentation Plan for capturing your project’s scope. Templates for the tools are provided in Appendix A – Templates as screenshots. An outp
... 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
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
Dependencies are relationships between activities where the success of one activity depends on another,
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 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
Provide an agreed-upon content development method for a team of writers.
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
If your project involves multiple deliverables (and most technical writing projects do), your Documentation Plan will be supported by a Deliverables Matrix, which lists every document to be written and their key attributes.
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
The Deliverables Worksheet, Deliverables Matrix and Status Tracker are designed for use in projects with multiple deliverables,
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
Assumptions are educated guesses that underpin your planning and scheduling.
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
Deliverable A tangible output such as a technical document (user guide, procedure, manual or other output) that is produced as a result of a project or process.