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.
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, Constraints and Dependencies are where the logic underlying your planning and scheduling is made explicit.
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
Documentation Plans are vital documents for many reasons: they give shape to the expectations of your project; provide a forum for discussing and agreeing on the scope with a wide range of stakeholders; and, perhaps most importantly, serve as a contract of sorts between you and the company, showing what is expected to be delivered in the agreed
... 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
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 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
... 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
In a documentation project, focusing on the audience requires asking the right questions, such as: Who’s going to read this document? What’s the education level of the audience, and what are its top need-to-know priorities? Do these users need a complete reference or just a getting started guide?
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
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