Recall that writing is a process. Instructions sets, in particular, often require revision and editing to be sure the steps are clear and logically ordered. Below is a checklist to assist you in your revision and editing process.
revision checklist for instructions
- Write a good introduction—indicate the exact procedure to be explained, indicate audience requirements, and provide an overview of contents.
- Use headings and subheadings to organize sections and subsections.
- Create a section listing equipment and supplies, if necessary.
- Use consistent and appropriate style and format conventions for all headings, lists, special notices, and graphics.
- Use various types of lists wherever appropriate. In particular, use numbered vertical lists for sequential steps.
- Provide supplementary explanation of the steps as necessary.
- Use graphics to illustrate key actions or objects.
- Use special notices as appropriate.
- Write a conclusion. Let your reader know they’ve finished the project and offer support desk or troubleshooting information, if appropriate.
Candela Citations
CC licensed content, Original
- This chapter is a derivative of Online Technical Writing by Dr. David McMurrey, licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Located at: https://www.prismnet.com/~hcexres/textbook/. License: CC BY-NC-SA: Attribution-NonCommercial-ShareAlike. License Terms: Technical Writing Essentials by Kim Wozencraft is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License except where otherwise indicated.