Purpose

At the heart of technical writing is translating information for different levels of understanding. Whether you’re producing safety documentation for an engineering device or outlining the methods and significance of a research project for a grant proposal, you must describe complex, specialized knowledge so that someone else can understand and act on it. But before you can translate your knowledge, you have to understand your audience’s background and needs.

This assignment invites you to practice core skills of analyzing your audience and modifying your description and writing style to meet their needs.

Deliverables

This project has three phases:

1. Technical Description

Genre: Process description
Word count: 500-750 words

First, you will write a technical description of a process you might complete in a typical job in your field. Imagine a freshman in your major asks you, “what do you do?” or “what do people in this field do?” This is a chance to explain one of those processes. The goal of a technical description is to describe a field-specific process or product so that somebody without prior experience can understand and visualize it. You will need to consider how to convey this process in a way that a 100-level student in your major could understand your explanation even if they lack advanced technical vocabulary. Your technical description will help me learn more about your field of interest. The technical description is also a low-stakes way to practice for the second phase of the assignment, when you will describe a technical problem or need faced by someone else.

2. Client Needs Report

Genre: Report
Word count: 750-1,000 words

Next, you will write a report centered around a technical definition of a client’s need. Begin by identifying a consulting client to serve as your audience for the rest of the semester – ideally, one related to your particular field. Your chosen client will shape the writing decisions you make for the next several weeks, so choose carefully. You will research this client to analyze their needs and problems, then write a short report addressed to your classmates describing one particular need or problem that your client faces. In future assignments, you will be collecting additional research on this particular problem and eventually proposing ways to address it; for now, focus on providing a well-researched assessment of the client’s needs and a technical description of one significant problem they face.

3. Usability Report

Genre: Report
Word count: 500-750 words (including user test)

Finally, to evaluate your client needs report, you will develop a unique user test (i.e. a survey form, template, etc.) based on predetermined criteria. You will administer this test to your peers and use the results to decide on a revision plan. You will write a usability report addressed to me describing your user test, the results, and your planned revisions.