Technical Writing Process: The simple, five-step guide that anyone can use to create technical documents such as user guides, manuals, and procedures
amazon.com
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 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
One of the first things that any good writer should do before they put pen to paper is create a Documentation Plan. This key document defines the scope of your project (the documents you’re going to write, who the intended audience is, etc.) and the process you’ll follow to execute the project.
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
Constraints are the boundaries of your project. They’re usually expressed in terms of cost, time and scope,
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
Purpose describes the reason for the existence of the Documentation Plan
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
Requirements are the high-level needs that your documentation project must fulfil
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 – particularly those who partner with a project in the early stages – can help identify bugs, provide valuable feedback in testing out features, suggest new features, and assist the team in developing project
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
A Deliverables Matrix takes the scope one step further, breaking down each deliverable into a spreadsheet and listing each deliverable against its key characteristics.