ENGL210: Technical Writing

5.2: Writing the Process Document

• 5.2.1: Organization and Formatting

  • David McMurrey's "Online Technical Writing: Examples, Cases & Models" URL

    Review three of the links to examples under "Instructions, Policies & Procedures, Standard Operating Procedures" and "User Guide" sections. Review the section you read earlier, paying attention to "Common Sections in Instructions."
    

  • David McMurrey's "Common Page Design: Make it Accessible, Professional"

    Read this section.

  • Writing Activity: Formatting Assignment

    In a paragraph (50-75 words), discuss how the examples you reviewed used the common sections and formatting for technical writing. In a second paragraph, brainstorm your own plan for writing a process document/instructions in terms of what sections and formatting you will use.
    

  • Writing Activity: Process Draft Assignment

    Take the idea for instructions/process document you have been brainstorming and develop this into a first draft of your instructions/process document for a specific audience. You can either choose a new topic to approach or expand on the screen capture directions exercise you completed in Unit 4.
    

• 5.2.2: Supplementing with Visuals

  • David McMurrey's "Graphics: Picture This" Page

    Review this link on choosing graphics for technical writing.
    

• 5.2.3: Language Concerns

  • Angela Eward-Mangione's "You-Centered Business Style" Page

    Read the full document. Pay close attention to "Case Study 2: Promoting Safety in User Manuals." Using the "Principles and Guidelines for Practice," revise your instructions/process document for a “you” centered approach.
    

  • David McMurrey's "Power-Revision Techniques: Sentence-Level Revision: Every Word Deleted is a Victory!" Page

    Read this section. Go through each bullet point and evaluate your current draft of the instructions/process document for these elements of clarity. Revise as needed.
    

  • University of North Carolina at Chapel Hill, Writing Center: "Gender-Sensitive Language" Page

    Read this article.

  • Writing Activity: Gender-Sensitive Language Assignment

    In a paragraph (50-75 words), discuss why gender sensitive language is important and note any revisions needed to ensure your instructions/process document uses gender sensitive language.

• 5.2.4: Concrete Language

  • Angela Eward-Mangione's "Professional and Technical Writing Processes: Composing" Page

    Review the section on drafts, specifically concrete versus abstract language. Review your latest draft of the instructions/process document. Improve any areas of abstract language.
    

• 5.2.5: Anticipating Audience Reaction

  • Writing Commons: "Overcoming Barriers to Effective Written Communication" Page

    Read the entire document. Consider the questions in the final paragraph under the "Review, Reflect, and Revise" section. Review your instructions/process document for a final time. Anticipate your audience’s reaction to the message. Are there any barriers to communication? Are there any nonverbal aspects to your message? Is your document visually attractive? Could be clearer in some way? More concise? Revise the document one more time.