|
What You’re Building | The Weeks Ahead | At a Glance | The Criteria, Explained | The Process, Applied |
What You’re Building
The final project is one substantial guide, manual, or reference resource that you build on your own, for a real audience, using every step of our Tech Writing Process.
All semester you have practiced the six steps one at a time, usually on a situation or a set of materials someone else handed you. The final project puts all six together, and this time you make the calls: the topic, the audience, the genre, and the medium.
The genres on the list are the documents organizations depend on every day: manuals, training guides, SOPs, handbooks, and knowledge bases. Think of them as the job aids and instructions you wrote earlier, scaled up. A job aid helps with one task. A manual or knowledge base supports a whole process, often for months or years.
|
In practice: Documents like these get used long after they are written. New employees learn from them, teams settle disagreements with them, and people pull them up in the middle of a task they have forgotten how to do. The writer usually isn’t there to explain, so the document has to do the job on its own. |
The Weeks Ahead
Each week from here on builds part of your final project.
Every remaining genre focus is a piece you will actually use. You’ll pitch your idea, propose a plan, report on your progress, and get feedback, so the project moves forward a step each week instead of piling up at the end.
- Week 11: Start thinking about your project idea.
- Week 12: Pitch your idea to the class, then learn to write a proposal.
- Week 13: Turn in your proposal, then learn to write a progress report.
- Week 14: Turn in your progress report, then trade drafts for peer assessment and reflect on your own work.
- Week 15: Finish the project and prepare your final presentation.
- Finals week: Turn in your final project, then present it to the class. The final presentation is not part of your final project grade.
At a Glance
Here is everything the project requires. Each item is explained in the next section.
- Scope: Individual assignment.
- Topic area: May be drawn from your discipline, work, or hobby. The client may be real or fictional.
- Expected work time: About 15 hours.
- Focus: Must support a specific audience as they engage with or address a real-world problem, process, activity, or need.
- Genre and medium: Choose one genre and one or more mediums from the lists below.
- Required elements:
- Written content: about 2,500–3,500 words, roughly 8–10 pages. On a website, count the words across all pages.
- Visuals or multimedia: at least 5, student-created. Charts, tables, images, diagrams, screenshots, video, and audio all count, as long as you made them. An image copied from the web doesn’t count toward the 5, though you can still use one with credit. Give every visual alt text (a short description of what it shows for readers who can’t see it), and give every video or audio clip captions or a transcript.
- Minimum number of sources: 4. Sources can include manuals, websites, articles, and interviews with people who know the subject.
- Final product: Everything should fit together as one complete piece, not a collection of separate parts. Use the same design throughout, give readers a way to move between parts (such as a table of contents or site menu), and place videos and visuals where readers need them.
The Criteria, Explained
What each requirement means, and how to meet it.
Scope
This is an individual project. You can and should get feedback from classmates and from the people your guide is for, but the planning, writing, and design are your own.
Topic Area
Your topic can come from your major, your job, or a hobby. The best topics are ones you already know well, because your own experience counts as research and saves you time.
Your client can be real, such as your employer, a club, or a family business, or it can be fictional. If you invent a client, keep the audience realistic. You should be able to describe your readers in detail in your reader profile.
Expected Work Time
Plan on about 15 hours spread across the final weeks of the semester. That time covers research, planning, drafting, building visuals and multimedia, and revising.
Learning a new tool takes real time, but none of that time shows up in the finished product. If you have never used a tool before, choose one you can learn in an hour or two.
Focus
Your project must support a specific audience as they engage with or address a real-world problem, process, activity, or need. The test is whether your readers will use the document, not whether the topic is serious. A hobby topic works fine as long as someone uses the result to do something, learn something, or look something up.
- Meets the focus: A new-player guide for a D&D group, a lore wiki that players consult during a campaign, an SOP set for a campus lab, a troubleshooting guide for a home espresso machine.
- Doesn’t meet the focus: A short story set in a D&D world, an opinion essay on a policy, a personal résumé.
Genre
Choose one genre from the table. The examples show what each genre looks like in the real world.
| Genre | Description | Examples |
|---|---|---|
| User guide / instruction manual | How to use or assemble a product, tool, or piece of software | Apple iPhone User Guide REI Expert Advice |
| Training guide / onboarding manual | Lessons or a sequence for new employees, volunteers, or learners | Google’s technical writing courses Food Safety Basics Participant’s Workbook (PDF) |
| Operations manual / SOP set / playbook | Procedures for routine tasks and recurring situations in a business, lab, or club | Atlassian Team Playbook School Food Service SOPs (PDF) |
| Safety manual | Hazards, procedures, and emergency response | UT Austin Lab Safety Manual (PDF) |
| Maintenance & troubleshooting guide | Upkeep schedules, repairs, and fixes for common problems | iFixit troubleshooting pages Cathy Moore’s Action Mapping headquarters |
| Handbook / guidebook | Policies, practices, and orientation for an organization, program, or place | Basecamp employee handbook Texas Driver Handbook (PDF) |
| Field guide | Identification or reference for a domain, such as plants, tools, or parts | Wildflower Center Native Plant Database |
| Knowledge base / FAQ system | Organized answers to recurring questions | Mozilla Firefox Support |
Medium & Tools
Every tool listed here is free, so you will never need to pay for software to complete the project. If you already own a paid tool you like, you’re welcome to use it. You can also combine mediums, such as a website with embedded videos.
DocumentA traditional document, designed for print or reading on screen and submitted as a PDF. Every genre works as a document.
|
WebsiteLinked pages that readers move through with a menu. Good for guides that readers search or return to.
|
InteractiveReaders click through choices or lessons instead of reading top to bottom. |
Step CaptureTools that record you doing a task on screen and turn it into step-by-step instructions with screenshots, which you then edit and write around. |
Video & AudioVideo and audio can be part of your guide, such as a short tutorial embedded on the page where a reader needs it. They can’t be the whole product. If you include video or audio, submit your scripts with the project. Scripts, captions, and the text around your media all count toward the writing requirement.
|
The Process, Applied
Here is how one student might choose a genre and medium, then work through the six steps.
|
Theo’s situation: Theo runs a weekly Dungeons & Dragons game for his campus game club. New members keep joining partway through the campaign, and each one spends their first session lost. Some don’t come back. The club officers have asked him for something they can send to newcomers before their first game. |
Theo’s Game Plan
Before he builds anything, Theo works through the same questions you’ll answer in your pitch.
- What is he making? A training guide. He considered a knowledge base, but new players don’t know enough yet to know what to search for. They need to be walked through the game in order, which is what a training guide does.
- Who is it for, and why does it matter to him? Club members who have never played a tabletop game. He runs the game, so he sees the problem every week, and he wants new players to stick around.
- What medium? A website built in Google Sites. He weighs the options against his readers:
- They’ll read on phones, often mid-game. A site menu lets them jump straight to the page they need. A PDF means pinching and scrolling through pages on a small screen.
- The guide will change. Rules get updated and the club adds house rules. A website updates in place, so the link the officers share always points to the current version. A PDF would have to be re-sent every time.
- It needs to hold video. Google Sites embeds YouTube videos directly on the page where readers need them.
- It fits his time. Google Sites is free, he already has a Google account, and the club officers already use Google Drive. Notion would work too, but it’s one more tool for the officers to learn. He also considered Twine for combat decisions but decided learning it would eat time he’d rather spend writing.
- What visuals and multimedia is he picturing? He matches each visual to the job it needs to do:
- An annotated screenshot of a character sheet. The sheet itself is what overwhelms new players, so labeling the real thing beats describing it.
- A flowchart of one combat turn. A turn is a sequence with choices, which a flowchart shows more clearly than a paragraph.
- A table of the dice. Players look up which die to roll over and over, and a table is built for quick lookup.
- Two short videos, each under two minutes. One shows rolling a character and one walks through a sample turn. Both are actions that are easier to watch than to read. He’ll make them in Clipchamp because it’s free, records both his screen and his camera (for the dice at the table), exports without a watermark, and adds captions automatically, which covers the caption requirement. Loom caps free videos at five minutes and doesn’t allow downloads, and ScreenPal adds a watermark and has no captions. He’ll upload the finished videos to YouTube as unlisted and embed them in the site.
- Sources, challenges, and open questions? The free D&D Basic Rules, interviews with veteran players, and the questions newcomers have asked him. His biggest challenge is keeping it short enough for a phone. He isn’t sure yet whether the videos will be worth the time.
Theo’s Six Steps
The six steps don’t happen in a neat line. Research changes what you know about your audience, drafting shows you problems in your outline, and testing works best early and often. Here is how the steps play out for Theo.
| Step | For your project | Theo’s version |
|---|---|---|
| 1. Analyze | Identify your audience, purpose, and genre. Write a reader profile. | His readers are new club members, and many have never played a tabletop game. They need to build a character and get through their first session, and most will read the guide on their phones, some of them at the table. He comes back to this step after his interviews (see Research). |
| 2. Research | Gather information from sources, experts, and your own experience. Use at least 4 sources. | He works from the free D&D Basic Rules, interviews two veteran players and a club officer, and lists the questions new players asked over the last few sessions. The interviews change his analysis: the veterans say new players get lost in combat, not character building, so combat moves up in his plan. |
| 3. Structure | Plan your key ideas, outline, style guide, and layout. | He outlines four pages: Before Your First Game, Your First Combat, Building a Character, and a glossary. His style guide covers how to format game terms, and he picks a layout that works on a phone screen. |
| 4. Write | Draft the full text, including any scripts. | He drafts each page and writes scripts for two short videos. While drafting, he finds the glossary is turning into a second guide, so he goes back to Structure and cuts it to the 20 terms new players actually ask about. |
| 5. Integrate Data & Graphics | Create at least 5 visuals or multimedia elements, with alt text, captions, or transcripts. | He builds the combat flowchart at the same time he writes the combat page, since the text and the visual explain the same thing. He adds an annotated screenshot of a character sheet, a table of the dice, and two captioned Clipchamp videos. That makes 5. |
| 6. Review & Revise | Get feedback from real readers and classmates, then revise. | He doesn’t wait until the end. After drafting the combat page, he has one new member try it during a real game and revises the spots where she got stuck. Later, two more newcomers test the full guide, and he works in what came up in peer assessment. |
|
In practice: Theo’s topic is a hobby, but his guide meets the focus requirement because new players use it to join the game. Notice, too, that his plan changed along the way. His pitch and proposal capture where he started, not where he had to end up. |