kuhnllc tools banner 

 kuhnllc templates banner
"Great ability develops and reveals itself increasingly with every new assignment."
-- Baltasar Gracian

Management Tips
Project Methodology
Project Close Lessons Learned
Project Planning
Project Management Templates
Project Manager Duties
Project Risk Management

Kuhn & Associates

<TITLE> Project

Documentation Requirements

Documentation Areas

  1. Functional Specification Document

This Functional Design Document is a system specification that is in line with the <COMPANY NAME> standards and is the guide for managers and developers as they create and test the application. It must either contain or refer to all the deliverable information.

The document must have the following features:

    • Understandable
    • Complete-meets all business requirements
    • Conforms to standards
    • Design accurately reflects the data structures and screen and report layouts
    • Design accesses the database and files in a logical and feasible manner
    • Create, delete and update actions do not break integrity rules
  1. Program/code documentation

The core idea underlying object-oriented software design is that a software system can be made up of small functional blocks called objects. The program code should include comments that identify the purpose of each section of code and how it relates to the application. Also, the software design should specify:

    • Objects that make up the system
    • Properties (methods and attributes) of the objects
    • How the objects are related to each other
    • How the objects may be combined into larger functional blocks called packages
    • How the objects work together to carry out a use case
  1. Training Guide

    2. The training guide is used to guide the instructor in providing training to end-users and support personnel. This activity involves the development of a guide that includes lesson objectives, lesson plans, and samples of all training materials.

  2. Training Materials

    3. Training materials are necessary to support training of the end-users of the application during the implementation stage. This activity involves development of presentation slides, instruction manuals, wall charts, etc. that will be used in the training sessions. It also involves obtaining copies of relevant documents, particularly sections of the user documentation, for distribution to the users during the training sessions.

  3. User Guide

    4. The user guide is necessary to support end-users of the application during operational use. This activity involves development of operating manuals that will be used in support of daily operations.

  4. User Quick Reference Guide

    5. The user quick reference guide is a ‘checklist’ format that is used to support end-users of the application during operational use. This activity involves development of reference cards and/or online help screens that will be used in support of daily operations.

  5. Support Guide

    6. Help desk personnel in supporting end-users use the support guide. This activity involves the development of a list of all available documents and an index to system documentation.

  6. <VENDOR SOFTWARE> Documentation

User/Admin and User/Training are guides for supporting end-users. This activity involves the development of a description of which users have access to <VENDOR SOFTWARE> and what the application does.

| Home | About Us | Clients | Project Management Resources | Tools & Templates | Links |