After doing this assignment, you should be able to:
- Prepare a finished draft of a documentation project
These will depend highly on the nature of the genre(s) included in your project, but will most likely include:
- a web browser (e.g., Firefox, Internet Explorer, Safari)
- a word processor, desktop publishing program, or other writing platform
What I hope you have been introduced to in this class is many of the standards, conventions, and best practices amongst many common situations, purposes, modes, and media of technical communication. There are a lot of ways to document information for a specific audience. Whatever final project you produce, it should:
- Exist in an accessible and usable format that utilizes effective document design (it should be formatted according to expectations for the specific genre you are creating).
- Target a specific, real audience of people.
- Successfully utilize the conventions common to the form of documentation you are creating, as exemplified by document designers working in the real world.
Essentially, think of this final project as packaging final drafts of your deliverables from Modules 2, 3, or 4, or some combination. You should think about orienting a manager to the deliverables you’ve created so that they can deploy your documentation.
Your final draft of your Documentation Project should include:
- An Executive Summary: explain the goals of your documentation, its audience, and a brief summary of the steps you went through to produce it. Also explain the purpose of each deliverable in your Documentation Project, including the documentation itself. Who is it for? What will it help them do?
- A documentation plan that lays out all the steps you went through to produce your project, based on the templates for doc plans I assigned in Homework #5 (note: you will also do this retroactively for the work you’ve done thus far)
- An audience persona
- A completed piece of documentation from Modules 2, 3, or 4, or some combination (i.e. a product specification and user guide; a content audit and usability review, etc.)
Documents You Must Produce for this Project
The following must be posted to Canvas by midnight on Monday, 11/23/20:
- Cover Letter, which should answer the following questions a) what have you learned about the processes of technical communication in this class? b) what have these processes taught you about your roles as a future writer within a specific career?
- A copy of your final project, including all the materials listed above
The primary audience for your project is your instructor, who will evaluate it based on the grading criteria, but the real, live audience for the genre you are creating is an important audience to consider as well.
To Complete This Project (Suggested Workflow)
1) Don’t forget to follow the best practices you have encountered and researched throughout this class. Revise your final project based on the feedback you’ve received throughout the class.
2) 11/23/20 by midnight >>
Final project due to Canvas, including all materials listed above
Grading criteria for final project