Enterprise Applications
Development Guidelines and Procedures
Appendix D: Systems Documentation
The purpose of the Systems Documentation for the Emergency Preparedness plan is to have a document for each system which would enable a person familiar with an HP3000 but unfamiliar with our systems to know where to go to get documentation for our systems. The documentation listed should be adequate to direct a person to all files which comprise the system. The following items should be included: Systems Overview, Image Schema, Powerhouse Schema, Processing Sequence, KSAM file rebuilds, Schema diagram, File index, User Documentation, and any other pertinent documentation file related to the overall system. This list should be kept on the CWIS server in a file named y:/sysadmin-share/sysdoc/yy/yybook.wpd (yy = system code). Following is an example:
Idaho State University (system name) Documentation
| Function | Location | To Print |
|---|---|---|
| System Overview | SYSDOC\yy\yyINTRO.WPD | WordPerfect |
| Image Schema | yyDBS.SOURCE.DESIGN | QEDIT list |
| Powerhouse Schema | yyQDBS.SOURCE.DESIGN | QEDIT list |
| Processing Sequence | SYSDOC\yy\yySEQ.WPD | WordPerfect |
| KSAM file rebuild | yyKSRBDJ.MAINT.hpaccount | QEDIT list |
| Database Diagram | SYSDOC\yy\yyDIAG.af2 | ABC Flowcharter |
| File index Report | FXFILESJ.MAINT.ADMIN | STREAMX |
| Design Specifications | SYSDOC\yy\yyDESIGN.wpd | WordPerfect |
| Database Edit | yyEDITJ.MAINT.hpaccount | STREAMX |
An index for access to applications, such as a list of command files and/or Security 3000 menus, should also be placed here if not provided by the file index system report.
(hpaccount = HP 3000 account on which the system resides.)
