Work Samples

Technical Editing Technical Writing

What's New? (#1)

Work Sample

⇨ Download What's New? (#1) (.chm file)

*NOTE: If you cannot view any topics after downloading: Right-click on the .chm file in the Downloads folder or wherever you saved it > Properties > General tab > Unblock*

Purpose

To get users excited about a new feature by analyzing what the user needs or wants and then writing about the new feature in that context.

A new W-9 Received field has been added to the Vendors form, a form that stores vendor information. The W-9 Received field is used to record the date that the agency received the last W-9 form from a vendor.

Audience Analysis

Accounts Payable specialists who would appreciate a quick and easy way to check whether any of their W-9s on file are outdated. Not only was the W-9 Received field added to the Vendors form, it was also added to an accompanying form that is used to query vendor records stored in the Vendors form.

I market the feature by explaining that the new field can be used in conjunction with query techniques to quickly find all outdated W-9s and I provide a brief example.

Tools Used

  • Microsoft Word (drafting)
    • Template
    • Navigation Pane
    • Track Changes
    • Comments
  • Madcap Flare (production)
    • Snippet
    • Conditional Tags
  • PureText

TOP OF PAGE

What's New? (#2)

Work Sample

⇨ What's New? (#2)

Purpose

To craft a comprehensive summary that announces the latest changes and updates for Affordable Care Act (ACA) reporting software in software version 5.14.1. 5.14.1 software followed the previous software version 5.14.

Audience Analysis

Payroll or Human Resources specialists who are familiar with ACA reporting in 5.14 software and 5.14 hotfixes. They want to learn the changes that have been introduced in 5.14.1 so they can print accurate 1095-C forms and submit accurate 1094-C files.

Tools Used

  • Microsoft Word (drafting and publishing)
    • Template
    • Navigation Pane
    • Track Changes
    • Comments
    • Save As (PDF)
  • Madcap Flare (production)
    • Conditional Tags
    • Targets
    • Single-source publishing
  • PureText

TOP OF PAGE

Press Release

Work Sample

⇨ Press Release

Purpose

For a school project, write a press release announcing new research results by the University of Washington related to efforts to create synthetic enzymes.

The results were not a smashing breakthrough but rather a good first step. I considered the following when writing to achieve the document's purpose:

  • Document is not a balanced news story but rather a public relations piece that is meant to stir up excitement and generate coverage
  • Avoided reporting potential negative aspects such as research costs, required length of time for success, and detailed feasibility of real-world applications

My research included attending a classroom presentation by one of the researchers (including Q and A session), and by reading the journal article for the study.

Audience Analysis

The primary audience is reporters and media members with a variety of science backgrounds. I treated the audience as a general audience and used the following techniques:

  • Explained the scientific items in general terms using analogies
  • Wrote a clear title that makes sense to a general audience
  • Discussed the real-world applications of synthetic enzymes in general terms rather than highly technical explanations

Tools Used

  • Microsoft Word

TOP OF PAGE

Case Study

Work Sample

⇨ Case Study

Purpose

For a school project, write a case study that demonstrates the advantages of an XML-based content management system (CMS) software product over its competitors by telling a story. This document achieves its purpose by explaining the following:

  • Situation: Background information so the reader can understand where there is room for improvement.
  • Solution: How the product can improve productivity.
  • Benefits: Facts and figures showing how the product increases productivity and why it is better than the competitors.

The subject of the story is a technical writer who works as a consultant at Microsoft who provided answers to questions during a Q and A session with myself and two others.

Audience Analysis

The primary audience of this document is technical writers who want to increase their productivity. However, I decided that this document would be most effective by explaining all terms instead of only addressing tech-savvy technical writers.

  • I explained all terms such as "source control" "schema" and "single sourcing" so a technical writer with a beginner's background could understand the concepts.
  • I use a Microsoft Word analogy to help explain the concepts.

Tools Used

  • Microsoft Word

TOP OF PAGE

Work Samples: News and Marketing