Technical Report

This is our big assignment for the term. It’s worth 70% of your final grade, and all of our conversations about technical writing will be against the backdrop of this assignment.

Please make sure you understand the whole assignment before you start thinking of ideas for the report!

Materials

Please use Microsoft Word to write your report. A lot of our class discussions will come back to things you can do in the desktop version of Word (not the Word Online or Word App versions!) to save time and effort in this class and in the future.

Due Date

The final report is due on the Wednesday of Finals Week, along with the rest of your Completion Portfolio.

A rough draft may be submitted by March 5. I won’t accept rough drafts after that date. If you do submit a rough draft, I’ll grade and provide feedback as though it was the final draft, but you can regain any and all lost points in the final draft if you resubmit by March 17 with your Completion Portfolio. (Data gathered over the past three years shows that a vast majority of people who submit a rough draft and respond to the feedback bump their scores at least 1 letter grade.)

What You Need to Do

A successful technical report will need to do the following.

Content Expectations

Find a subject that can be discussed technically

Technical reports can be about nuclear physics, advanced surgical procedures and cutting edge technologies. Technical reports can also be about Pokémon GO!, knitting and cooking on a college student budget.

The thing that makes a document technical is its persuasive, problem-oriented subject matter. Your subject must be discussed in a way that your audience can do a particular thing by the time they are done reading it. General information is not a good approach to subject matter for this report.

Determine a narrow, specific audience that cares about this information

Technical writing must always be audience oriented—that is, there must be a specific person or group of people who need this information. The general public isn’t good at acting on information they’re given, and “anyone who is interested” is too vague. Ideally, your audience should be so defined that we could mail a copy of your report to them at the end of the term.

A good audience has the capacity to act on the information you are providing them, and you should be able to dictate the action they’ll take by the end of your document. (Be persuasive here! The worst your audience can do is say no. If you don’t try to persuade them to something in particular, your audience can make the wrong choice, which is often worse than a “no.”)

Design your report to meet your audience’s needs

Your report will need to include graphical or other non-text elements. It must be broken up with headings. In general, your document must use visual features to convey information or offer cues to guide your audience in reading it.

Use language and evidence appropriate to your profession (or whatever expertise you assume)

Your report must be written from a standpoint of expertise. While we will do some research this term and you should learn something new along the way, you should not be learning a brand new subject from the ground up.

This includes writing with the level of jargon and other textual features appropriate to your field (as we discussed in the first few weeks of the term).

Use information ethically

Ethical information use includes having proper citations for all external references (in APA or IEEE format). Beyond that, it also includes choosing references appropriately to make sure they provide the best information possible for your discussion and choosing references that help you describe your subject from multiple angles.

Your research process in this course is going to be pretty wide-reaching. Technical documents don’t always rely on peer-reviewed academic sources like a WRI 122 paper. However, as we’ll discuss in class, research is a tool and the information you gather is the material for your project.

Document Expectations

  • Your report should be about 3000 words long (single-spaced: 5-6 pages).
  • Your report must have a cover page, table of contents, and table of figures.
  • Your report must be in APA or IEEE format, which includes citations (and your reference page!) and the rest of your document formatting (headings, headers, font-style, etc.). This also means your report must have some external references.
  • Your report must include at least one non-text element (table, chart, graph, picture, etc.).
  • Your report must include a Letter of Transmission to your target audience or an Abstract if you are writing to a disciplinary group.

Completion Portfolio

If you submit revisions, you must submit them as part of a completion portfolio. This portfolio is set of Word documents that help me understand how you accomplished our course objectives this term. If you do no revisions, the Completion Portfolio is extra credit.

This isn’t meant to be a big assignment. I used to have folks write these memos by hand during our final exam time, and most people took about 20 minutes to find all of the things they wanted to mention in their memo.

  • Please write a Completion Memo informing me of what parts of your report were revised. If you didn’t do many revisions, point me to the specific spots in your report where they occurred.
  • In your completion memo, please tell me three additional things:
    • Any assignments or activities from class that helped you in completing this project.
    • Any assignments or activities from class that were unhelpful (or even harmful).
    • Any skills or knowledge you learned in other courses that helped you complete this project.
  • Please include your revised report. Use Microsoft Word’s Compare tool (under the Review tab) to compare your old and new drafts. It will mark every change made in the document.
  • Please include the Technical Memos that felt like they assisted you the most in completing this project.

Grading

Your technical report is worth 70 points (remember that the course is graded out of 100 points overall. You must meet the Document Expectations above for me to grade your report at all. The grading is broken into three big categories: Purpose, Information and Formatting. While they are not included in the rubric, 0 scores are possible if an item is not attempted.

Completion Portfolio

Completing your Completion Portfolio components as requested above makes you eligible to regain points in revision.

If you do no revisions, the Completion Portfolio will add 2 points to your final grade.

Purpose: 30 points

  • Document Purpose 5

Clearly declaring your document’s purpose early in the report and sticking to it is worth 5 points. Declaring a purpose but failing to stick to it is worth 3 points. A vague purpose or a series of possible purposes is worth 1 point.

  • Conclusion 5

A clear conclusion that tells the audience what to do with this information is worth 5 points. A conclusion that reminds the audience of the document’s accomplishments but doesn’t say what to do is worth 3 points. A conclusion that simply restates main points is worth 1 point.

  • Document Focus 5

Maintaining your focus from beginning to end of the document—no irrelevant information or tangents not tied back to your main purpose—is worth 5 points. Introducing new points in the end of your document or failing to deliver on points you raise at the start of your document will reduce this to 3 points. A document that could easily be two or more short reports is worth 1 point.

  • Document Organization 5

A document with a clear, signposted structure and headings that effectively announce a section’s content is worth 5 points. A document with a clear structure or with headings that announce each section’s content is worth 3 points. A document with some recognizable structure is worth 1 point.

  • Paragraph Organization 5

Internal paragraphing that is detailed and concise is worth 5 points. Internal paragraphing that is very detailed but too long/dense (i.e. could be broken into smaller paragraphs) is worth 3 points. Internal paragraphing that is short or confusing is worth 1 point.

  • Audience Awareness 5

Using appropriate language and references for your audience and explaining technical jargon necessary for your subject is worth 5 points. Using simplified language and references for your audience but failing to incorporate any technical language is worth 3 points. Using over-simple language and references (below your audience’s level) is worth 1 point.

Information: 25 points

  • Quality of Source Material 5

Source material that provides ample data and/or discussion for you to draw from is worth 5 points (e.g. reports or resources from your professional organization’s website). Source material that just provides a little data or discussion is worth 3 points (e.g. a code manual), unless you use a large variety of these sources. Light source material that provides quotable statements but no real data is worth 1 point (e.g. WhyVegetablesAreHealthy.com).

  • Use of Source Material 5

Using, citing and explaining all of your sources well enough that your reader could use your references without tracking down the originals is worth 5 points. Effectively explaining your sources enough that a fellow expert in your field could re-use them is worth 3 points. Effectively explaining and citing your sources enough that your audience can understand what’s going on is worth 1 point.

  • Use of Personal Expertise 5

Using your personal expertise in this subject as a reference point and using it to validate some or all of your references is worth 5 points. Doing only one of those things is worth 3 points. Credibly claiming some expertise in the subject is worth 1 point.

  • Professional Rhetoric 5

Use of jargon and other language appropriate to the discipline you are writing for is worth 5 points. Generally technical rhetoric (but not associated with any discipline) is worth 3 points. An academic rhetorical style is worth 1 point.

  • Ethical Source Use 5

Ensuring that your reader understands what all of your sources’ stances are on an issue and (if applicable) using sources from several angles or stances on an issue is worth 5 points. Simply using your references at face value but not investigating or explaining them any further is worth 3 points. Cherry-picking resources to support the point you want to make reduces this to 1 point.

Formatting: 15 points

  • Style Use 5

Following your chosen style very closely is worth 5 points. Following your chosen style in just citation use is worth 3 points. Having a consistent style, but clearly not APA or IEEE, is worth 1 point.

  • Incorporation of Non-Text Items 5

Placing, captioning and referencing non-text elements appropriately (as discussed in class) is worth 5 points. Failing to caption or reference a non-text element appropriately is worth 3 points. Failing to place these elements appropriately is worth 1 point.

  • Proofreading 5

A document with no errors that a writing teacher would be distracted by is worth 5 points. A document with errors that would be noticed by the average reader is worth 3 points. A document with errors distracting to the average reader is worth 1 point.

css.php