The 29 Steps of a Documentation Project
Contents
Here is a traditionally recommended general sequence of the 29 steps for a documentation project:
- Discuss the need for the document with your client.
- Determine the purpose and objectives of the document.
- Talk to intended users of the documents.
- Profile the users’ information needs.
- Prepare an outline of the planned contents of the documents
- Design the layout of the document.
- Plan the online version of the document.
- Prepare style guidelines or a style sheet.
- Prepare a sample section of the document (a prototype).
- Estimate time and costs to write and produce the document.
- Schedule the project.
- Review document plan with client and get approval.
- Gather all relevant background information.
- Conduct detailed interviews with subject matter experts.
- Draft sections of the document.
- Prepare graphics.
- Format (layout) draft sections of the document.
- Edit draft sections.
- Review draft sections with subject experts and revise.
- Review draft sections with the project team and revise.
- Test accuracy and completeness of critical sections of the document.
- Prepare alphabetical index.
- Final edit and proofread.
- Review the completed document with the project team and get approval to print.
- Prepare the online version of the document.
- Design and print covers.
- Prepare printing specifications and coordinate printing.
- Distribute the printed document.
- Get feedback from the final users of the document on its effectiveness.
Lots of situations might call for changing this sequence a bit. Some software documentation is written for developers or even contributed by developers, such as docs for API or SDK. Following the philosophy of Docs-as-code, the document will be written in Markdown and published on a website; it may not need a print-out version like PDF. As a result, the procedure will change accordingly.
Author Susan
LastMod 2022-01-28