DSST Technical writting notes 1

Informal report directives incident reports and

Info icon This preview shows pages 3–4. Sign up to view the full content.

Informal Report - Directives, incident reports, and meeting minutes are typically written as informal reports, Feasibility reports are formal reports that require writers to evaluate and present multiple courses of action. Short sentences, simple words, and glossaries improve the ability to translate a document into another language Parallel sentence structure: The newly hired finance manager is experienced, outgoing, and you will learn a great deal from working with him. – ( "you will learn a great deal" is not balanced with "is experienced, outgoing) Filtering involves the use of visual patterns, such as symbols, to indicate different types of information in a document. Like placing a stop sign symbol beside every safety tip in an instruction manual Usability testing is a process of evaluating and revising instructional documents to improve safety and to detect potential problems for users. Technical Document - The educational background of an audience guides a writer's choice of vocabulary, sentence structure, and graphics. It would be appropriate for a writer to use sophisticated vocabulary for an educated audience but not for less educated readers. Reader preferences dictate decisions regarding the most appropriate tone of a document because the reader is the final judge Margins limit the amount of information that can be included on a page and provide necessary space for binding a document. Margins also allow authors to include marginal glosses, which are notes and definitions that appear in margins Feasibility Report - The cause and effect method of development is common in the recommendations section of a report. With the cause and effect pattern, a writer proposes that a recommended solution will lead to specific effects. Technical Documents - Sentences beginning with "there" and "it" are weak and should be avoided. Technical Documents - Low context cultures appreciate detailed information where procedures are explained completely. An audience of readers from a high context culture might be offended by the inclusion of information that is considered common knowledge. Schematic diagrams use lines and symbols to illustrate how a product or a process works. Informative abstracts expand upon descriptive abstracts by also summarizing the results and recommendations of a study. An overview at the beginning of a manual should address the purpose and benefits of the procedure to encourage readers to learn and retain the material. Exploded diagrams illustrate how parts of an item are assembled, so they are commonly found in maintenance and repair manuals. Multiple-line graphs and band graphs display numerical relationships Line graphs, pie graphs, and bar graphs are better at illustrating movements, distributions, and cycles than tables Working definitions are placed in the introduction of instructions so that readers understand terms used throughout the document. Troubleshooting tips and follow-up advice are included in the conclusion
Image of page 3

Info icon This preview has intentionally blurred sections. Sign up to view the full version.

Image of page 4
This is the end of the preview. Sign up to access the rest of the document.
  • Winter '12
  • None
  • Writer, technical document

{[ snackBarMessage ]}

What students are saying

  • Left Quote Icon

    As a current student on this bumpy collegiate pathway, I stumbled upon Course Hero, where I can find study resources for nearly all my courses, get online help from tutors 24/7, and even share my old projects, papers, and lecture notes with other students.

    Student Picture

    Kiran Temple University Fox School of Business ‘17, Course Hero Intern

  • Left Quote Icon

    I cannot even describe how much Course Hero helped me this summer. It’s truly become something I can always rely on and help me. In the end, I was not only able to survive summer classes, but I was able to thrive thanks to Course Hero.

    Student Picture

    Dana University of Pennsylvania ‘17, Course Hero Intern

  • Left Quote Icon

    The ability to access any university’s resources through Course Hero proved invaluable in my case. I was behind on Tulane coursework and actually used UCLA’s materials to help me move forward and get everything together on time.

    Student Picture

    Jill Tulane University ‘16, Course Hero Intern