01/11: (Online) Purposes of Technical Reports: By Field

Assigned Today

Pick a section/chapter or two of your report (aim for about 40 pages) to read before class on Wednesday. As you read, pay attention to the following things:

  • How frequently is jargon used? Does it get defined or described for a non-expert audience, or are you expected to already know it?
  • How would you describe the structure of this document?
    • Is the content given to you like a narrative, where the author(s) describe information in the chronological order that they gathered it?
    • Is the all of the content (research methods, findings, conclusions) summarized to you early on?
    • Is there a thesis, or does the document declare its point or purpose some other way?
  • What kind of data or evidence is provided? Are there a lot of citations? Did the authors gather a lot of information themselves?
    • When external sources are used, what kind of citations do you see? Are they MLA format (just an author name in parentheses), APA format (author name and year), IEEE format (a number in brackets), footnotes or something else?
    • When external sources are used, do you typically see direct quotes or summaries?
    • When external sources are used, is it one citation at a time inside parentheses/brackets, or are multiple citations given at a time?
  • Are there images/figures/tables/etc.?
    • What are they? (e.g. tables, pictures, charts, diagrams, etc.)
    • Are they captioned?
  • Do the authors use “I” or “you” anywhere in the document? (If you downloaded the PDF, you can just do a CTRL + F or Apple + F to find those words.)

Essentially, we’re looking for some traits that might differentiate technical writing from other kinds of writing, and we’ll hopefully find some more things that make your field different from others.

Today’s Content

We’ll spend most of today unpacking a lot of our findings from the weekend. The main goal is to get a sense of the scope of our reports compared to their length. The secondary goal is to get a sense of how each of our fields are different from each other in terms of our writing.

Key takeaways for today:

  • Appropriate scope
  • Benefits of common document structures

Leave a Reply

Your email address will not be published. Required fields are marked *

css.php