Enterprise Applications
Development Guidelines and Procedures
System and Program Documentation
Introduction
Systems Documentation at Idaho State University Computer Center varies widely with the system. Purchased software may be accompanied by systems manuals very much different from those developed in-house. In-house systems will vary depending on complexity and special requirements. Nonetheless, documentation developed in-house should adhere to the following basic guidelines.
Systems documentation should be kept in machine readable and printable format whenever possible. It is our goal to keep an on-line set of documentation completely up to date and accessible by all users and Computer Center personnel who should benefit therefrom. A set of procedures for obtaining systems documentation must be maintained.
Additionally, one hardcopy systems manual and related documentation such as program listings should be kept up to date in the office of the person responsible for maintaining the system. A copy of the systems manual should be provided to the Manager of Administrative Systems upon system implementation. Although this manual will quickly become outdated it will serve as a much needed overview to the system. The copy provided to management should contain key screens and report samples, but program listings are not required.
Many of our users do not have their own systems but have jobs, procedures, etc., which required our assistance to create but are under their control (example: Hplist and Quiz reports). For each such user the individual assigned responsibility must maintain a paper file. This file should contain listings of job setups, special instructions, and other information provided to the user (SOURCExy is the place to keep on-line copies). This will facilitate timely aid to the user when they make changes for which assistance is required or inadvertently delete their file. This will provide a minimum of interruption to their service as responsibility changes occur in the computer center.
Documentation will not be left to the end to be developed but rather done as each individual portion of a project is produced. This will ensure adequate time is taken when details are fresh and readily available.