Technical Writing Process
The Technical Writing Process
Build a website Web page design Facebooks
The technical writing process consists of four phases:
planning writing delivery archiving The phases of the technical writing process
are not necessarily discrete. You might start the writing phase before you complete the planning stage, for example, or you might have to deliver the documentation before you feel it is finished. It is highly unlikely, however, that you will ever archive the documentation before you deliver it!
Some products are released several times. In this situation, you might be in the delivery phase of the first iteration of the project while you are in the planning phase of the second iteration. Don't panic: overlap in the technical writing process is quite normal.
Every project is different. The process described here might not exactly describe your situation, but it will be pretty close.
Managing Your Documentation Projects, by JoAnn Hackos, provides more detailed information about the technical writing process.
The Planning Phase
Gather existing information—any or all of: requirement specifications functional descriptions use cases standards contracts etc. Determine which documents and other information you will create: product descriptions installation guides configuration guides system administration guides alarm-clearing procedures routine maintenance procedures command reference guides online help error messages notifications tooltips etc. Note: Ensure that you know the terms of any contracts between you and your client or employer, or between your client/employer and their client. If a document is not specified in the contract, do not write it without first talking to your supervisor. [My thanks to Judith in Australia for telling me about a company that didn't check the contract.]
If the documentation is to include tooltips, error messages, notifications, and dialog boxes, develop a plan to ensure that the
Build a website Web page design Facebooks
The technical writing process consists of four phases:
planning writing delivery archiving The phases of the technical writing process
are not necessarily discrete. You might start the writing phase before you complete the planning stage, for example, or you might have to deliver the documentation before you feel it is finished. It is highly unlikely, however, that you will ever archive the documentation before you deliver it!
Some products are released several times. In this situation, you might be in the delivery phase of the first iteration of the project while you are in the planning phase of the second iteration. Don't panic: overlap in the technical writing process is quite normal.
Every project is different. The process described here might not exactly describe your situation, but it will be pretty close.
Managing Your Documentation Projects, by JoAnn Hackos, provides more detailed information about the technical writing process.
The Planning Phase
Gather existing information—any or all of: requirement specifications functional descriptions use cases standards contracts etc. Determine which documents and other information you will create: product descriptions installation guides configuration guides system administration guides alarm-clearing procedures routine maintenance procedures command reference guides online help error messages notifications tooltips etc. Note: Ensure that you know the terms of any contracts between you and your client or employer, or between your client/employer and their client. If a document is not specified in the contract, do not write it without first talking to your supervisor. [My thanks to Judith in Australia for telling me about a company that didn't check the contract.]
If the documentation is to include tooltips, error messages, notifications, and dialog boxes, develop a plan to ensure that the