{"id":485,"date":"2019-06-20T18:39:16","date_gmt":"2019-06-20T18:39:16","guid":{"rendered":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/?post_type=chapter&#038;p=485"},"modified":"2019-07-18T19:01:24","modified_gmt":"2019-07-18T19:01:24","slug":"485","status":"publish","type":"chapter","link":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/chapter\/485\/","title":{"raw":"10.4 Revision Checklist for Instructions","rendered":"10.4 Revision Checklist for Instructions"},"content":{"raw":"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.\r\n<div class=\"textbox key-takeaways\">\r\n<h3>revision checklist for instructions<\/h3>\r\n<ul>\r\n \t<li>Write a good introduction\u2014indicate the exact procedure to be explained, indicate audience requirements, and provide an overview of contents.<\/li>\r\n \t<li>Use headings and subheadings to organize sections and subsections.<\/li>\r\n \t<li>Create a section listing equipment and supplies, if necessary.<\/li>\r\n \t<li class=\"p1\">Use consistent and appropriate style and format conventions for all headings, lists, special notices, and graphics.<\/li>\r\n \t<li>Use various types of lists wherever appropriate. In particular, use numbered vertical lists for sequential steps.<\/li>\r\n \t<li class=\"p1\">Provide supplementary explanation of the steps as necessary.<\/li>\r\n \t<li>Use graphics to illustrate key actions or objects.<\/li>\r\n \t<li>Use special notices as appropriate.<\/li>\r\n \t<li>Write a conclusion. Let your reader know they've finished the project and offer support desk or troubleshooting information, if appropriate.<\/li>\r\n<\/ul>\r\n<\/div>","rendered":"<p>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.<\/p>\n<div class=\"textbox key-takeaways\">\n<h3>revision checklist for instructions<\/h3>\n<ul>\n<li>Write a good introduction\u2014indicate the exact procedure to be explained, indicate audience requirements, and provide an overview of contents.<\/li>\n<li>Use headings and subheadings to organize sections and subsections.<\/li>\n<li>Create a section listing equipment and supplies, if necessary.<\/li>\n<li class=\"p1\">Use consistent and appropriate style and format conventions for all headings, lists, special notices, and graphics.<\/li>\n<li>Use various types of lists wherever appropriate. In particular, use numbered vertical lists for sequential steps.<\/li>\n<li class=\"p1\">Provide supplementary explanation of the steps as necessary.<\/li>\n<li>Use graphics to illustrate key actions or objects.<\/li>\n<li>Use special notices as appropriate.<\/li>\n<li>Write a conclusion. Let your reader know they&#8217;ve finished the project and offer support desk or troubleshooting information, if appropriate.<\/li>\n<\/ul>\n<\/div>\n\n\t\t\t <section class=\"citations-section\" role=\"contentinfo\">\n\t\t\t <h3>Candela Citations<\/h3>\n\t\t\t\t\t <div>\n\t\t\t\t\t\t <div id=\"citation-list-485\">\n\t\t\t\t\t\t\t <div class=\"licensing\"><div class=\"license-attribution-dropdown-subheading\">CC licensed content, Original<\/div><ul class=\"citation-list\"><li>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. <strong>Located at<\/strong>: <a target=\"_blank\" href=\"https:\/\/www.prismnet.com\/~hcexres\/textbook\/\">https:\/\/www.prismnet.com\/~hcexres\/textbook\/<\/a>. <strong>License<\/strong>: <em><a target=\"_blank\" rel=\"license\" href=\"https:\/\/creativecommons.org\/licenses\/by-nc-sa\/4.0\/\">CC BY-NC-SA: Attribution-NonCommercial-ShareAlike<\/a><\/em>. <strong>License Terms<\/strong>: Technical Writing Essentials by Kim Wozencraft is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License except where otherwise indicated.<\/li><\/ul><\/div>\n\t\t\t\t\t\t <\/div>\n\t\t\t\t\t <\/div>\n\t\t\t <\/section>","protected":false},"author":92081,"menu_order":6,"template":"","meta":{"_candela_citation":"[{\"type\":\"original\",\"description\":\"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\",\"author\":\"\",\"organization\":\"\",\"url\":\"https:\/\/www.prismnet.com\/~hcexres\/textbook\/\",\"project\":\"\",\"license\":\"cc-by-nc-sa\",\"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.\"}]","CANDELA_OUTCOMES_GUID":"","pb_show_title":"on","pb_short_title":"","pb_subtitle":"","pb_authors":[],"pb_section_license":"cc-by-nc-sa"},"chapter-type":[],"contributor":[],"license":[54],"class_list":["post-485","chapter","type-chapter","status-publish","hentry","license-cc-by-nc-sa"],"part":103,"_links":{"self":[{"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/chapters\/485","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/chapters"}],"about":[{"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/wp\/v2\/types\/chapter"}],"author":[{"embeddable":true,"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/wp\/v2\/users\/92081"}],"version-history":[{"count":5,"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/chapters\/485\/revisions"}],"predecessor-version":[{"id":532,"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/chapters\/485\/revisions\/532"}],"part":[{"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/parts\/103"}],"metadata":[{"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/chapters\/485\/metadata\/"}],"wp:attachment":[{"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/wp\/v2\/media?parent=485"}],"wp:term":[{"taxonomy":"chapter-type","embeddable":true,"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/pressbooks\/v2\/chapter-type?post=485"},{"taxonomy":"contributor","embeddable":true,"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/wp\/v2\/contributor?post=485"},{"taxonomy":"license","embeddable":true,"href":"https:\/\/courses.lumenlearning.com\/sunyulster227technicalwriting\/wp-json\/wp\/v2\/license?post=485"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}