Assignments for Semester-long Project Syllabus

Home Page
The Author
Instructor.Resources
Student.Resources
Programs

iChat
Message Board
Buy the Book

 

 Assignments for the Semester-Long Project Syllabus

This page supplements the syllabus and the textbook by providing extra information about each assignment. The descriptions below offer you tips on how to succeed with each assignment. 

Documentation Set

This assignment is your major project for the semester, and consists of a complete documentation set for a software program of your choosing. The other assignments, outlined below, all tie in with this assignment. It requires you to select a program (usually a shareware utility from an ftp archive), study users, design documents, and produce documents to support the efficient operating of the program and the effective application of the program to meaningful workplace tasks.

The following are among the kinds of documents you might produce for this assignment:

  • Getting started (tutorial)
  • Installation (procedural)
  • Quick reference (reference)
  • User's manual (procedural/combination)
  • FAQ (Frequently Asked Questions) (reference)
  • Help (procedural/reference)
Each person's document will differ depending on the program you choose and the program user's needs for information.

Documentation Plan

This 3-4 page document comprises the planning you do for your documentation set. It specifies the design of your documents (format, content, users) and your plans for creating the documents (schedules for drafts, reviews, etc.).

User Analysis

This 2-3 page document identifies the users of your documentation set and their software documentation needs. It follows the seven-part user analysis scheme presented in Chapter 5.

Test Report

This 1-2 page document outlines the usability testing you did on your project. It identifies the document goals, explains and justifies the kinds of tests you do, discusses the results of the tests, and lists the changes you made to the document in response to the results.

Review Report/Meeting

This document outlines the review issues you faced in producing your report and identifies changes made in light of the reviews. You will present these issues and results of your reviews in a meeting with your support team.
 

This page maintained by Thomas Barker thomas.barker@ttu.edu  Hit Counter  Copyright © 2003 Pearson Education, publishing as Longman Publishers  Legal Notice