Short Reports: How To Write Routine Technical Documents

I don’t get to teach technical writing much anymore, so when I touched on it in a new media class I took the opportunity to freshen up some older web resources.

A business memo, a lab report, or a professional e-mail are all variations on the basic report structure described in this document.  Feel free to modify these guidelines in order to meet your reader’s needs.

  • Think of Your Reader First
    Your busy reader has a problem, and has turned to your report for help. What, exactly, does your reader want? Deliver it as efficiently as possible.
  • Begin with Your Conclusions
    A technical document is not a mystery novel. Don’t save your best points for the end, because most readers are too impatient to wait.
  • Organize with Appropriate Headings
    For any document longer than a page or two, break the content into sections (like introduction, background, discussion, and conclusion).

via Short Reports: How To Write Routine Technical Documents — Jerz’s Literacy Weblog.

Post was last modified on 15 Sep 2017 11:19 pm

Share
Published by
Dennis G. Jerz

Recent Posts

The choreographer daughter is doing a thing.

The choreographer daughter is doing a thing.

2 days ago

So I’m starting a thing. Wish me luck. #blender3d #medieval #york #mysteryplay #corpuschristi

So I’m starting a thing. Wish me luck. #blender3d #medieval #york #mysteryplay #corpuschristi

3 days ago

No interior yet. Getting there. Gotta start somewhere. Low-poly background detail for a medieval theater project. #blender3d

No interior yet. Getting there. Gotta start somewhere. Low-poly background detail for a medieval theater…

3 days ago

This is manageable. Far better than some semesters.

This is manageable. Far better than some semesters.

4 days ago

Creating textures for background buildings in a medieval theater simulation project. I can always improve this later. #blender3d

Creating textures for background buildings in a medieval theater simulation project. I can always improve…

5 days ago

Yesterday my stack of unmarked assignments was about 120, so this is not bad.

Nothing in this stack is pressing, but they do include rough drafts of final papers,…

5 days ago