Thumbtack essay
Revised thumbtack essay
Pencil essay
Audience essays
Coral reefs rewrite
Resume and cover letter
Proposal
Illustrations
Software manual
Website
Elevator speech
First draft of final report
Long speech
Article for publication
 
Home Page

Software Manual

Write a manual describing the "prime" program (to be provided).

Your target audience is comfortable using Athena and UNIX. However, these same people, believe it or not, know nothing about prime numbers. (Okay, this target is a wee bit contrived.)

Your manual must contain the following five sections:

Cover Page

Just provide a title and your name. Don't waste time making it look pretty.

Installation

Explain how readers can obtain the tar file and "untar" it.

This section should consume about half a page.

The installation steps are as follows:

  1. Log in to Athena.

  2. Mount the remote directory:
      $ add 21w.780
      
  3. Copy the installation file to your home directory:
      $ cp /mit/21w.780/Rosenberg/ComputerManual/shrink_wrap.tar.Z .
      
  4. Uncompress the installation file:
      $ uncompress shrink_wrap.tar.Z
  5. Untar the installation file:
      $ tar -xvf shrink_wrap.tar
  6. Change directory to package as follows:
      $ cd package
      

You can now experiment with prime.ksh.

Tutorial/Guide

Explain what prime numbers are. Then, take readers by the hand and guide them through this program. I would expect this section to consume about two or three pages. Worthy guides usually do the following:

  • Explain the program's features.
  • Provide lots of examples.
  • Warn about the program's pitfalls and limitations.

Reference

Provide a reference page, containing brief descriptions of all three options (v, p, and r). Use UNIX reference pages or other sample reference pages as your guide.

This section should consume one page.

Index

Create an index containing at least 25 entries. Your index can contain "See Also" entries but cannot contain any "See" entries. The "See Also" entries do not count towards your goal of at least 25 entries.

This section should consume one page.

Fonts

Please use the following font conventions:

  • Place all "body" text in a serif font.

  • Place all heads in a sans-serif font.

  • Place all examples in a fixed-width font.

Be consistent with your font choices. If you use 14-pt Futura for a second level head in one part of your manual, make sure that you use 14-pt Futura for a second level head on all other parts of your manual.

I've written a FrameMaker template for this manual. Feel free to use it or ignore it. Perform the following steps to access the template:

  1. Mount the class directory by typing the following Athena command:
      % add 21w.780
  2. Copy the FrameMaker template file to your home directory.
      % cp /mit/21w.780/ComputerManual/TemplateSoftwareManual.fm ~
  3. In FrameMaker, open your copy of the FrameMaker template file.