User and Maintenance Manual Outlines

User and Maintenance Manual Outlines

1

User and Maintenance Manual Outlines

Computer Science 145

University of North Carolina at Chapel Hill

Boss: Professor Greg Welch

Client: Professor Russell Taylor

March 8, 2001

Team Members:

Jeff Adams

Brian Boyd

Glenn Jessup

Jeff Townsend

User Manual

Document Change History

  • March 8, 2001
  • None – Unique Document: Outline Format

Table of Contents

1. Introduction

1.a Purpose of Document – User manual for user level understanding of how to run the program, the individual parts of our program, installing our program, and trouble shooting.

1.b Target Audience – Common everyday computer users – not too technical, but with general computer knowledge

1.c Document Conventions – Typical document conventions… major sections split by lines, TNR 14 Bold for section titles, TNR 12 for typing and bold for subsection titles

1.d Reader Starting Points – Quick Start, Tutorial and Reference

2. Quick Start

3. System Overview

High Level Diagram from Design Specifications or Contract II

4. Tutorial

One complete example that we will run when our program is functional – will include screen shots of complete example

5. Reference

A decomposition of product, in a logical running time order… closely related to Tutorial

6. Index

If document is too long, Index will be added

7. Appendices – Will be added closer to the completion of our product

7.a Quick Reference Card

7.b System Requirements – appropriate JVM at least, nanoViewer

7.c Installation

7.d Troubleshooting

7.e Maintenance Procedures and Issues

7.f Contact Information (names, email, and appropriate credit legalities)

Maintenance Manual

Document Change History

  • March 8, 2001
  • None – Unique Document: Outline Format

Table of Contents

1. Introduction

1.a Purpose of Document – User manual for user level understanding of how to run the program, the individual parts of our program, installing our program, and trouble shooting.

1.b Target Audience – Significantly more technical than the User Manual… designed for experienced computer users

1.c Document Conventions – Typical document conventions… major sections split by lines, TNR 14 Bold for section titles, TNR 12 for typing and bold for subsection titles

1.d Other relevant documents – All appropriate documents will be added

2. System Overview

Includes:

- A HL image showing our modules.

e.g. an updated image from our presentation.

- A brief description of the data flow between modules.

An explanation of the arrow diagram from our presentation.

- A description of each module.

- A description of module/program control.

Show how FrontEnd controls program progress.

- Description of directory structure.

Explain dir structure in our prototype.

- Image from presentation showing directory example.

- List of required files and files included with our project.

List including pbn converter and Nano, along with nanoIndexer.java

- List of file locations.

Where can these be found if they are not already installed.

Explanation of where files should be installed.

3. Procedures

Editing the source code:

Revision Control: This section will describe the revision control system used to check in/check out the source code.

Documenting Revisions: Here we will define standards for providing documentation, within the source files, of any code that is added to the system.

Building the system: Here we will list the dependencies of each source file in the system and the order in which they must be compiled. This include the dependencies on programs outside of the system, including the image converter and nano viewer.

Testing the system: This section will include descriptions of all tests that must be passed in order for the system to be fully operational. This will include sample test input and expected output of the tests. Debugging tips might also be provided, like possible causes of particular errors that may occur. Here we will also describe how to test each module individually.

Starting the system: The commands and commandline options for starting the nanoIndexer will be listed here. Each option will have a detailed description of its function. The default values for each option will also be listed.

Updating Documentation: This section will define the formats of the system's manuals and the procedures for revising them.

4. Index – depending on size of document

5. Appendices

Development System Requirements (include compiler versions, etc.)

Modules: (written by module programmers for the Outline)

FrontEnd Module:

  • Describe the form and function of the module.
  • Explain FrontEnd as program controller.
  • Give an example showing module execution.
  • Trace the flow of progress thorough the module.
  • Explain methods within the module.
  • Explain the various methods used.
  • Explain data flow between modules.
  • Trace data flow to and from FrontEnd.
  • Explain variables.
  • Mention possible desired changes and steps to make changes.

DirList Module:

*Functions: This will describe the functions that are provided by the DirList module.

*Parameters: Here we will list the names and locations of any constants that are used by the DirList module. Each parameter will have a description of its usage within the module and acceptable values for each parameter.

*Errors: Any errors that may occur within the DirList module will be described here.

Viewer Module

This module is a driver that calls the nano viewer program and as such is affected by changes to the nano –index option. The command line string that viewer uses to call nano may depend on the particular system and version of nano. This section will include specific information about the nano viewer called.

ImageConvert Module

This module is a driver that calls two netpgm utilities, tifftopnm and pbmtojpeg, to convert a tiff image to jpeg. The first utility convert the tiff to pnm format then pipes this intermediate image to the second utility, which converts to jpeg. This assumes netpbm 9.11 and availability of jpeg libraries. Changes in image conversion software or operating system may affect the command line string that imageConvert uses to call the utilities and the necessary piping. This section will include specific information about the image converters called.

CreateHTML

  • Functions: This will describe the functions used in the HTML creation process.
  • Parameters: Here we will list the names and locations of any constants that are used by the createHTML module.
  • Errors: Descriptions of errors of createHTML module.

Troubleshooting

Contact Information (your names, Client name, current emails, etc.)

Client Contract (final)

Design Specification