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
Assumptions are educated guesses that underpin your planning and scheduling.
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.
Dependencies are relationships between activities where the success of one activity depends on another,
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.
Requirements are the high-level needs that your documentation project must fulfil
Improve predictability of technical writing projects.
Benefit of having the process in place
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.
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.
you also have to know when to write them! This is where the Documentation Timeline and Schedule come in. The purpose of these tools is to help you work out the timeframe of your project (i.e. create a schedule), and put that schedule into a format that others can understand.