studio 1151 |
press releases |
guidebook |
accompanying documentation |
Accompanying Documentation
Accompanying documentation serves two purposes. First, it is a marketing tool. Your team has created this wonderful product and now you must "sell" it to your audience. Secondly, your audience needs information on how to truly benefit from what it has "bought". Note: The examples are not necessarily complete. They are included to get you started.
The accompanying documentation should provide your audience with information on the product's purpose or the benefits it offers, its intended audience, the topic(s) covered, and any other information which you think will get your audience to use your product, including information on any equipment, hardware, or software requirements.
Example:
"Understanding Your Automobile" provides an interactive environment for people to learn about what goes on under the hoods of their cars. It is specifically designed to increase confidence in diagnosing and fixing problems with cars. Men and women of any age who feel somewhat to very intimidated by all the wires, hoses, and metal under the hoods of their cars will benefit from "Understanding Your Automobile".

"Understanding Your Automobile" requires the following hardware and software configurations:

  • Requires Macintosh 680x0 or later and hard disk with 8.0 MB free.
  • System 7.0 compatible.
  • Must have 8 MB RAM, color monitor and Sound Blaster.

The accompanying documentation should also provide your audience with detailed instructions on how to use the product. After all, you want your audience to actually benefit from what you've worked so hard to produce. Below is a list of information you may want to include.
  1. Step-by-step instructions on how to get started.
    Example:
    To get started with "Understanding Your Automobile" double click the "Understanding Your Automobile" icon. Click Start to begin the program.
  2. Navigation and other logistical information.
    Example:
    To move a car part, just point, click, and drag the part into its proper place.
  3. Descriptions of what will happen in each segment, screen, etc.
    Example:
    In this first segment, you will meet Camry Toyota who will be your guide as you learn about what is under the hood of your car. You'll begin with the engine. At the end of this first segment you'll review and practice what you have learned.
  4. Emphasis, hints, elaborations, additional information.
    Example:
    Remember, you can go back to a previous screen at any time to refresh your memory. The radiator is usually found toward the front of the engine compartment. The most important thing to remember here is...
  5. Troubleshooting.
    Example:
    Problem: I can't get to the next screen. Solution: Some screens require you to complete several actions before you can move to the next screen. Make sure you have completed all the required actions, then click the right arrow to move on.
Additionally, if your product is to be used in a classroom setting, the accompanying documentation should include information on how teachers can best utilize your product with their students. This information might be as brief as suggestions on how or where your product could be incorporated into the classroom or as elaborate as an entire lesson plan.
Example:
"Understanding Your Automobile" may be used as supplemental self-instructional material for students who want or need additional instruction in an introductory automobile repair course.


S tudio 1151 Guidebook by Karen McNally and Alan Levine
Maricopa Center for Learning and Instruction (MCLI)
Maricopa Community Colleges

The Internet Connection at MCLI is Alan Levine --}
Comments to alan.levine@domail.maricopa.edu 

URL: http://www.mcli.dist.maricopa.edu/authoring/studio/
            guidebook/doc.html