DSST Technical writting notes 1

Pull quotes attract reader attention and are

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

Pull quotes are short quotations pulled out of a document and highlighted with large type size and a text box. Pull quotes attract reader attention and are frequently used in newspapers, newsletters, and brochures. Marginal gloss is information, such as definitions, that appears in the margins of a document. Graphics are common tools for expanding a definition in a technical document when a writer needs to elaborate about either a physical object or a concept. Spatial sequencing presents information in a product description in the order in which users view the product, such as from top to bottom or left to right. A product description in a functional sequence describes the order in which parts operate Process descriptions explain the steps and stages of a process while product descriptions describe physical objects Visuals should be placed as close as possible to the text being clarified but not before the text, as this may confuse readers. A large visual belongs in an appendix at the end of the document Page grids serve as maps for technical writers to help them determine the placement of text, graphics, and white space An internal proposal is submitted within an organization for the purpose of requesting money, changing policies, or conducting research. Solicited proposals are external to an organization. Trouble reports describe problems, such as job site accidents or equipment failures. Feasibility reports are internal reports that present information about the practicality of a suggested project Line graphs illustrate changes over time and would be most appropriate for depicting sales trends. Prose tables organize explanations, instructions, and descriptions. The documentation system of the Institute of Electrical and Electronics Engineers (IEEE) is primarily used for technical documents related to scientific and mathematical fields. The IEEE system uses bracketed numbers— [1]—that correspond to complete citations in the bibliography. Appendices should be arranged in the order that they are mentioned in a document and labeled with letters instead of Roman numerals. Each appendix should start on a separate page
Image of page 4

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

Technical writers often use emphatic sequence to support an opinion or make a recommendation. Reasons are arranged in either decreasing or increasing order of importance to emphasize a point. Informational reports provide results, but analytical reports provide results and draw conclusions based on those results. Being selective is the key to compiling an index, so writers should choose passages from the text where a topic is fully discussed rather than briefly mentioned. Orphans are words or short lines that are alone at the end of a column. Widows are single words or short lines carried over to the top of a page or column.
Image of page 5
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