01/27: Affordances: Utility (St. Dominick)

Assigned Today

Remember that your second technical memo is due at the end of the week.

Today’s Content

We’ll keep diving in to the Grounding of the St. Dominick. Now, we’ll look at the affordances granted by the document’s intended utility. We’ll pay specific attention to the top of the first page and the bottom of the last page: this document exists as part of a larger body of work, and we’ll need to understand how its utility can determine a lot of structural parts of our document.

We will need to make use of the Accident Briefs at the NTSB website (LINK) to see some of these affordances in action.

01/25: Affordances: Subject Area (St. Dominick)

Assigned Today

Your second Technical Memo is due at the end of the week.

Today’s Content

We’ll dive in to the Grounding of the St. Dominick, and we will talk about the affordances technical reports give us when it comes to subject matter.

We’ll pay attention to:

  • Headings
  • Theses (or the lack thereof)
  • Writer expertise/authority and their ability to act

Specifically, we’ll look at how clearly declaring a report’s purpose and subject area allows you to sidestep some research and discussion, as well as how it allows you to dive really deep into particular issues.

01/22: Constraints of Technical Writing. (Tech Writing Presentations Assigned)

Assigned Today

Over the weekend, sign up for a Technical Writing Presentation slot.

Re-read the Grounding of the St. Dominick, and read the Open Technical Communication chapter on Reports (LINK).

Today’s Content

We’ll talk through the TWP assignments in class and get into the constraints of technical writing. A constraint is sort of the opposite of an affordance: it’s something that a technology disallows or impedes you from doing because of its design.

We’ll talk about the ways technical writing offers us a variety of affordances and constraints, and I will give you all a few examples of these kinds of documents to exemplify these traits: a PowerPoint from NASA and a research report we’ll talk about in a few weeks.

01/20: Technical Report Project Overview; Affordances of Technical Writing

Assigned Today

On Friday, please bring a short list (2-3 items) of writing things you don’t understand, have questions about or frequently get marked wrong in your writing. (You don’t have to say which is which.)

Today’s Content

We’ll talk about the technical report assignment a lot here. I want to make sure everyone knows what we’re getting into over the rest of the term.

Beyond that, we’ll also talk about the concept of affordances: something that a technology allows you to do by virtue of its construction. That definition seems pretty broad, and it’ll be weird to think of technical writing (or reports) as a technology, but we’ll push the idea as far as we can.

We’ll breeze through a few economic reports to talk about the evolution of report structures:

  • An 1832 report by John Kay Shuttleworth on the then-current economic plight of textile mill workers in England (LINK)
  • A 1945 USDA bulletin/report on consumer spending during the war (LINK)
  • The 2020 Fed report on Monetary Policy (LINK)

01/15: (Online) Technical Memos

Assigned Today

We’ve got a long weekend ahead of us, but I don’t expect you to do any of this work on Monday.

Between now and Wednesday, please complete the first technical memo assignment

Between now and Wednesday, please also read the Technical Report assignment page.

Today’s Content

We’ll talk about memo and email formatting along with technical descriptions. Largely, this is because I’m going to ask you to do these things in your first writing assignment over the weekend.

But, we’ll also talk about the relationships between these things. Specifically, a technical description asks you to do specific rhetorical moves (and avoid others) that we also usually do in memos and emails.

Key takeaways today:

  • Formatting!
  • Also, structure.

01/13: (Online) What Makes My Field Different?

Assigned Today

Please read the Open Technical Communication chapters on Memos and Emails (LINK) and on Technical Definitions and Descriptions (LINK) by Friday.

Today’s Content

Today, we’re going to work in groups (and we’ll see how well I can shuffle folks around over Zoom) to discuss our reports we’ve found. Our goal will be to come up with a technical definition of technical writing and of technical writing in our fields by the end of the day, much like we did with hot dogs on the first day of class.

But wait! We haven’t ever talked about technical definitions, have we?

For today, we’ll focus on just some major elements of such a definition:

  • Characteristics of this kind of writing (use of jargon, presence of pronouns, citation use, heading types, etc.)
  • Functions or uses of this kind of writing
  • Types of audiences
  • Reasons this writing is produced

Hoepfully, we’ll all come out with a shared definition of technical writing in general, and we should all walk away with some idea of how writing in our field is different from others.

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

01/08: (Online) Purposes of Technical Reports

Assigned Today

Before Monday, head to NAP.edu. This is the website of the National Academies Press (the National Academy of Science, the National Academy of Engineering and the National Academy of Medicine).

Use the Search bar to search for a subject that interests you, or use the Browse By Division menu at the top to find a subject area that interests you or browse around the home page for something that looks cool.

You must find something from or related to your major, field of study or career path (or else our discussions over the next week or two won’t make a lot of sense). You also must find a report-style document: Consensus Study Report, Framework or Playbook. Proceedings are not appropriate for this assignment.

Before Monday, please skim through your selected report. These tend to be very long documents—the one in the image below is over 300 pages long. I don’t expect you to read the whole thing, but we will talk about the structure of these documents compared to the Grounding of the St. Dominick.

Either download the free PDF of your chosen report or read it online. Do not buy it unless you really, really want to.

The entry page for reports, briefs and other materials. Do not buy any books for this class!

Today’s Content

We’ll keep talking about the St. Dominick today, and we’ll discuss that Open Technical Communication chapter.

We’ll talk about what makes the St. Dominick brief a technical document. Specifically, we need to work through the rubric we’re given:

  • Technical documents are audience focused
    • But who is the brief’s audience?
  • Technical documents are persuasive and problem-oriented
    • What is persuasive in this document?
    • What problem is it solving?
  • Technical documents are design centered
    • What non-text elements are used to enhance the message of this document?
    • How is text stylized to enhance the message of this document?
  • Technical documents are research and technology oriented
    • What research area or technology is this brief meant to support?
    • Hey, that raises a big question: what is technology?
  • Technical documents must be ethical
    • What does that even mean?
    • Do y’all remember ethos from your academic writing classes?

The easy part of this conversation is that we need to figure out what makes this different from academic writing (the stuff you did in WRI 121/122 or a Humanities class).

Now, the hard part about this conversation is that none of us are going to produce an NTSB accident brief for this class (or probably ever in life). So, what can we take from this document as nurses, electrical engineers, dental hygienists, professional writers, civil engineers, programmers, mechanical engineers…?

Key takeaways for today:

  • Technical writing is different from academic writing in more than just subject matter
  • Technical writing has to meet a few criteria to qualify as such
  • Technical writing isn’t the same between all fields: civil engineers, dental hygienists and musicians will all discuss bridges in very different ways

01/06: (Online) Features of Technical Writing

Assigned Today

Please read the first chapter of Open Technical Communication (LINK) before class on Friday.

Today’s Content

We’ll focus on that St. Dominick reading. Our main goal is to talk about what makes this document similar to / different from the kinds of things we have to produce as students. There is a lot to cover in these few pages, but I’ll try to make sure we address the points below:

  • What’s the deal with that giant block of information at the top?
    • Why include it if the same information is in the document text? Why include the document text if we have that block at the top?
  • What’s the relationship between the text and images/tables in this document?
    • What do the images add to our understanding of this situation? (We’ll specifically look at the first few images.)
    • Do the images do anything for us other than add to the length of this document?
    • If we removed the images, would the document lose important information?
  • What’s the deal with the headings?
    • Do they help us as readers? How?
    • Does it seem like the structure of this document (that is, the order in which each subject is discussed) is important?
  • Does the report say the accident was anyone’s fault?

By Friday, please read the technical writing textbook chapter linked at the top of this page.

css.php