0.006/03/92 G. TAYLOR 1.0 SYSTEM NARRATIVE ----------------- THE DOC SUBSYSTEM IS USED TO CREATE, MAINTAIN, AND PRINT SYSTEM AND PROGRAM DOCUMENTATION. THERE ARE TWO TYPES OF INPUT RECORDS, FIRST IS THE JOB INFORMATION RECORD WHICH CONTAINS THE PROGRAMMER NUMBER AND ROOM NUMBER FOR THE JOB CARD. THE SECOND IS THE PROGRAM INPUT RECORD WHICH CONTAINS THE SYSTEMS OR PROGRAMS FOR WHICH DOCUMENTATION IS TO BE PRINTED. THE DOCUMENTATION FOR A SINGLE PROGRAM CAN BE PRINTED BY SPECIFYING 'P' AND THE PROGRAM ID ON THE INPUT RECORD OR ALL DOCUMENTATION FOR A SUBSYSTEM CAN BE PRINTED BY SPECIFYING THE SUBSYSTEM AND 'ALL' AS THE PROGRAM NUMBER. FOR EXAMPLE, 'REGALL ' WILL PRINT ALL OF THE REGISTRATION DOCUMENTATION. SYSTEM DOCUMENTATION CAN BE PRINTED BY SPECIFYING 'S' AND THE SYSTEM PREFIX ON THE INPUT RECORD. THE PROGRAM WILL ALSO PRINT UP TO SEVEN DIFFERENT SECTIONS OF PROGRAM DOCUMENTATION AND THREE SECTIONS OF SYSTEM DOCUMENTATION. PROGRAM DOC530 READS THE INPUT RECORDS AND THE INDEX FILE FROM THE PDS SPECIFIED ON THE INPUT CARD AND FORMATS THE JCL THAT WILL EXECUTE PROGRAM DOC532. THE INDEX SUPPLIES THE PROGRAM WITH THE PROGRAM NAME AND COLLEGE ID. THE PROGRAM ALSO READS THE TRANS- ACTION SEGMENT OF THE CONTROL DATABASE TO GET THE SUBSYSTEM NAME. OUTPUT FROM THE PROGRAM IS A JCL FILE WHICH IS INPUT TO THE SECOND STEP OF THE DOC530 PROC WHICH SUBMITS THE FILE TO THE INTERNAL READER OF THE SYSTEM. THE PROGRAM DOC532 READS THE INPUT RECORDS GENERATED BY DOC530 AND PRINTS THE DOCUMENTATION. DOC532 STARTS A NEW PAGE WHENEVER THE LINE COUNTER 'LINE-CNT' IS EXCEEDED OR SECTION 3.0 STARTS MORE THAN 30 LINES DOWN THE PAGE OR IF AN '*' IS FOUND IN COLUMN 1. * 2.0 USER OPERATION INSTRUCTIONS --------------------------- THIS SECTION DESCIBES THE JOBS IN THE DOC SYSTEM. SEE THE PROGRAM DOCUMENTATION FOR THE JCL NEEDED TO RUN THOSE JOBSS. DOC JOBS DESCRIPTION -------- ----------- DOC500 PRINTS DATA DICTIONARY DOCUMENTAION DOC520 PRINTS INDEX OF SIS DOCUMENTAION DOC530 PRINTS SYSTEM/PROGRAM DOCUMENTAION 3.0 FILES ----- SOAD.SIS.PARTPROD.DOC 4.0 PROGRAM DOCUMENTATION --------------------- HERE IS A LIST OF THE PROGRAMS AVAILABLE AND THE REPORT HEADINGS FOR EACH. PROGRAM REPORT DESCRIPTION ------- ---------------------------------------------- DOC530 CREATE AND PRINT DOCUMENTATION DOC5302 PRINT DOCUMENTATION 5.0 IMPLEMENTATION -------------- CREATE SUBSYSTEM OR PROGRAM DOUCUMENTATION MEMBERS ON SOAD.SIS.PARTPROD.DOC. ADD THE MEMBER NAMES TO THE INDEX MEMBER. THE DOC JOBS CAN THEN BE RUN. 6.0 PROGRAM CHANGE HISTORY: ----------------------- 6.1 CHANGE DATE: 06/04/92 PROGRAMMER NAME: G. TAYLOR PROGRAM CHANGE REQUEST NO: DESCRIPTION OF CHANGE: CREATED THIS DOCUMENTATION MODULE.