email class email instructor course resources progress reports documentation project professional document revision analyzing writing practices course calendar course policies

Documentation Project

In this project, you'll work in collaborative teams to produce print or online documentation that explains how to accomplish a particular task using a particular piece of software or hardware.

Your choices could include:

  • a tutorial on how to accomplish a specific computer-related task in a Purdue ICS lab (for example, using your career account, scanning documents, accessing and using specific software)
  • a tutorial on how to accomplish a specific computer-related task in a class or classes in your major (for example, using a particular piece of software to analyze data or generate reports)
  • a tutorial how to accomplish a specific computer-related task of interest to a Purdue student (for example, finding and using Purdue job resources, creating an online resume, accessing information online at Purdue)

We'll brainstorm ideas for documentation, and then you will all vote on the top four ideas, which will then be assigned to groups for projects.

Purpose of this project

This project will allow you to learn more about producing documentation for specific groups of users, collaborative writing, document cycling, and usability testing. It aligns with the following course goals: Writing in Context, Writing Process, Collaboration, Research, Technology, and Document Design.

Process and Products

This project will be done in several stages. Further information about the activities you'll be expected to do in class and outside of class will be available on the course calendar, so make sure to check it frequently to keep up with the process.

  • First, your collaborative team will decide what kind of documentation you want to produce form (print or online) that it will take, conduct a user analysis of the audience(s) for your documentation, and make a list of and the tasks that will be addressed in your tutorial. You'll submit a memo that gives a preliminary analysis of your users and presents a preliminary list of tasks for your tutorial on Monday, October 28.
  • Second, you'll develop a plan for your project design that will explain both content and layout. You'll submit a detailed memo that outlines your tutorial development plan and your document design plan on Monday, November 4th.
  • Third, you'll work to draft your documentation, which will be due on Monday, November 11th.
  • Fourth, you'll develop a plan for and then do user-testing on your documentation and write a report detailing your results. Your user testing plan will be due on Monday, November 18th. Your report, along with a copy of the original documentation, is due on Monday, December 2nd.
  • Finally, after class discussion, user testing, and instructor feedback, you'll revise your document one last time and turn in a final copy of your draft, a memo to the instructor, and individual collaborative evaluation forms on or by Wednesday, December 11th.

Grading

You can earn a total of 400 points for this project.

Component
Point Value
Preliminary analysis memo 50 points
Project plan memo 50 points
Draft of documentation 50 points
User testing Plan 50 points
User testing report 100 points
Final draft (and forms) 100 points
Total 400 points

Grading rubrics will be attached to any major documents I return to you to explain how I scored your documents and to give you feedback. Extra credit is not a possibility for this project.

Dates to Remember

 

 

Course Policies || Course Calendar || Analyzing Writing Practices || Professional Document Revision || Documentation Project || Progress Reports || Course Resources || E-mail Instructor