Documentation Standards for Implementation Phase
Contents
1. Action i Support Staff i Add new Nil i AI SP When i Clear Maintenance i staff window lis Screen activated Call Support Program i Staff List SSLSTFF Previous Record Alt P No Record retrieved i ilstrecordalready displayed Next To ek DE 6 12 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE Window Event Window jStatup _ bcc MINE i Input Staff Code must be numeric call proc read staff Staff Code returning Staff Details Development Enable the input of Development Experience Experience i field check box i Un check Set Development Experience to Nil isable the input of Development Experienc Confirm Button Click Retrieve iif then Procedure i Remarks proc read commlib I codes 9 12 Remote Procedure Call staff status X 1 locate in Database Server Activate event 11000 if i proc scan scanlib bitmap Procedure supplied by the photo scanner vendor Refer to XXX document for details H P P Program Limits Unit Test Record 6 13 DOCUME2. i No Test Description Expected i Actual EE ETNE Results Im reate a new project Auto generated as expected project ID and project successfully created i Amend the newly created project fields amended expected i project start end date correctly roject name 4 Handling Correct error Invalid action value message displayed Non exist team code Non exist user dept code as expected 6 10 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 5 2 Example 2 Client Server Online Update The following program specification describes an online update program accessing data located in Database Server and client Program ID SSMSTFF Mode Online Update Program Name Maintain Support Staff Information Description The program create update delete Program Environment Program Source ssmstfffrm ssmstffbas O Change the table structure of STAFF to keep track the date the staff transfer from i support team to other team atabase i Server roc insert staff Staff Code c read staff Staff Code i Client 6 11 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE Input Parameters
3. PXX003 10 3 OTHER ERRORS HANDLING PROCEDURES 10 3 1 Input Tape Error Handling Error Message Handling Message E010 Invalid Control File SQL Error 1 Verify the parameter values 2 Correct errors 3 Resubmit the job Check the file content Contact OGCIO Support j ASAP Te If typing mistake rerun from beginning If not typing mistake contact User for correct I P Parameter during office hours Information only Inform E030 Subscriber not exist i hours Project team during office DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 10 4 JOB RESTART PROCEDURE 10 4 1 001 10 4 1 1 Normal Job Steps 000001 PXXX0001 JOB PXXX YYYY PRINT DAILY REPORT 000002 CLASS P MSGCLASS X MSGLEVEL 1 1 000003 RESTART XXXXXXXX 000004 REGION 8M 000005 000006 JOBLIB DD DSINS cec erento 000007 O000D00BR 000009 gt 000010 JOBPROC 000011 000012 DELETE FILES 000013 000014 DELSTEP EXEC PGM IEFBR14 are NG 10 4 1 2 If job aborted on step DELSTEPI Replace 000001 PXXX0001 JOB PXXX YYYY PRINT DAILY REPORT 000002 CLASS P MSGCLASS X MSGLEVEL 1 1 000003 RESTART XXXXXXXX 000004 REGION 8M to 000001 PXXX0001 JOB PXXX YYYY PRINT DAILY REPORT
4. Checklist i OTHER REPORTS MICROFILM MICROFICHE Thei Microfiche Rol Ereg i i Description Master Copy i OPERATION DESCRIPTION ON LINE SCHEDULE Wionday roen Friday 10800 1800 7 ADHOC SCHEDULE Request are forwarded to Production Control via Job Submission Form DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 9 RUN JOB SPECIFICATIONS 91 PXXZZZnn 9 1 1 Function To merge all I P Master Records To sort Master Records To print Master Record list 9 1 2 Estimate Run Time 15 minutes 9 3 Parameters Nil 9 1 4 Requirement Limitations Run daily at 18 00 after close of On line CICS Cannot run with other batch job 9 1 5 Program Sequence 9 1 6 Restart Procedure In case of System error simply rerun job from Job Step Other than System Failure please refer Chapter 10 9 1 7 Output Listings Journal P1030LST Master Record List DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 10 ERROR HANDLING Unless otherwise specified in Run Job Specification that it would affect the on line service on next day or immediate on line service all jobs are considered non critical Operator would contact Support Staff only if critical job failed again after carried out normal restart recovery actions Usually it is Data Base updating job that would affect the on line serv
5. seas 8 5 8 7 RUN JOB SPECIFICATIONS eet e odeur epe PR VIA aH e Hein 8 5 8 8 ERROR HANDEING od gest 8 6 8 9 TELUSTRATION PE 8 7 9 APPLICATION USER MANUAL guisenseissprsssnrssnennsensensernesennessnssteenesnennnsssdsenvnenteen 9 1 9 1 PURPOSE 9 1 9 2 TABLE OP CON TEN IS agave 9 2 DOCUMENTATION STANDARDS CONTENTS FOR IMPLEMENTATION PHASE 9 3 26 RU MR EXISTE 9 3 9 4 EQUIPMENT CONEBIGUR A TION 9 3 9 5 SUMMARY OF OPERATION PROCEDURES esee 9 3 291 Ver Procedures urat sebo dena 9 3 952 Terminal Input Procedures iie nee Rennen 9 5 9 6 RUN SCHEDULE moir ce nc M ur 9 6 9 7 COMPUTER INPUT gn 9 6 9 8 COMPUTER OUTPUT DOCUMENTS nad 9 6 99 TERMINAL OPERATING INSTRUCTIONS 4 esee 9 7 10 COMPUTER OPERATING PROCEDURES 10 1 10 1 PURPOSE 4 aiia 10 1 10 2 TABLE OF CONTENTS 10 2 APPENDIX A CROSS REFERENCE BETWEEN SSADM DELIVERABLES 1 AND THE CORRESPONDING DOCUMENTS SECTIONS B GOA PROJECTS sagene 1 CROSS REFERENCE BETWEEN OOM DELIVERABLES C 1 AND THE CORRESPONDIN
6. FOR IMPLEMENTATION PHASE PROCEDURES MANUAL 8 COMPUTER SYSTEM OPERATING PROCEDURES RESTART CASE 8 1 Reloading Procedures 8 2 Reconfiguration Switching of Network 8 3 Degraded Mode Operating Procedures 9 MAGNETIC TAPE HANDLING 9 11 Tape Deck Handling 9 2 Magnetic Tape Failure Recover Reporting 9 3 Labeling of Magnetic Tapes 10 OPERATION HOUSEKEEPING JOBS 10 1 System Files Backup 10 2 Magnetic Media Cleaning 10 3 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPENDIX A APPENDIX A CROSS REFERENCE BETWEEN SSADM DELIVERABLES AND THE CORRESPONDING DOCUMENTS SECTIONS Document Section SSADM Deliverables SYSTEM MANUAL Purpose N A 2 Scope N A 3 References N A 4 Definitions and Conventions N A 5 System summary 5 Objectives N A 5 2 System functions Function Definition 6 Equipment configuration Selected Technical System 6 1 Computer hardware Option 6 2 Ancillary machine 6 3 Consumable and media 7 Software Inventories 7 1 Inventory of application programs Process Module 7 2 Inventory of system software Selected Technical System Option 7 3 Inventory of software package 8 Security and backup Audit Control and Security Requirements 9 Database administration N A Constraints List 10 System constraints and limitations 11 Function point analysis Function Point Analysis DOCUMENTATION STANDARDS APPENDIX A FOR IMPLEMENTATION PHASE Document Section SSADM Deliverables PROGRAM MANUA
7. S8 B 2 DOCUMENTATION STANDARDS COMPUTER OPERATING FOR IMPLEMENTATION PHASE PROCEDURES MANUAL DOCUMENT SECTION GOA Deliverables APPLICATION USER MANUAL 1 PURPOSE 2 SCOPE 3 REFERENCES 4 DEFINITIONS AND CONVENTIONS 5 SYSTEM SUMMARY 51 OBJECTIVES 5 2 SYSTEM FUNCTIONS 6 EQUIPMENT CONFIGURATION 6 1 COMPUTER HARDWARE 6 2 ANCILLARY MACHINERY N A 6 3 CONSUMABLE AND MEDIA N A 7 SUMMARY OF OPERATION PROCEDURES 7 USER PROCEDURES 7 2 TERMINAL INPUT PROCEDURES N A 8 RUNSCHEDULE N A 9 COMPUTER INPUT DOCUMENTS N A 10 COMPUTER OUTPUT DOCUMENTS N A 11 TERMINAL OPERATING INSTRUCTIONS N A 12 SYSTEM MESSAGE BROADCASTING 13 DOCUMENTATION 14 SERVICES AND SUPPORT Ref No S8 B 3 DOCUMENTATION STANDARDS COMPUTER OPERATING FOR IMPLEMENTATION PHASE PROCEDURES MANUAL DOCUMENT SECTION GOA Deliverables COMPUTER OPERATING PROCEDURES MANUAL 1 PURPOSE 2 SCOPE 3 REFERENCES 4 DEFINITIONS AND CONVENTIONS 5 COMPUTER SYSTEM INFORMATION 5 1 HARDWARE CONFIGURATION 5 2 HARDWARE COMPONENTS DESCRIPTION N A 5 3 SYSTEM SOFTWARE ENVIRONMENT N A 5 4 SYSTEM FILES N A 6 COMPUTER SYSTEM OPERATING NORMAL N A 7 COMPUTER SYSTEM OPERATING ABNORMAL N A 8 COMPUTER SYSTEM OPERATING RESTART TAPE N A 9 MAGNETIC HANDLING 9 1 TAPE DECK HANDLING 9 2 MAGNETIC TAPE FAILURE RECOVER 9 3 LABELLING OF MAGNETIC TAPES 10 OPERATION HOUSEKEEPING JOBS 10 1 SYST
8. This part should describe all output documents produced by the system and detailed instructions on the checking of such documents A completed sample of each output documents should be given Printout id Purpose No of copies Filing instructions Checking instructions Messages displayed Meaning and action 9 6 DOCUMENTATION STANDARDS APPLICATION USER MANUAL FOR IMPLEMENTATION PHASE 9 9 TERMINAL OPERATING INSTRUCTIONS This part should describe in detail steps and instructions in operating terminal It should cover Power on off of the Terminal e Signing on off e Meaning of function keys e Preliminary fault diagnosis checking lamps setting modems e Fault reporting 9 7 DOCUMENTATION STANDARDS COMPUTER OPERATING FOR IMPLEMENTATION PHASE PROCEDURES MANUAL 10 10 1 COMPUTER OPERATING PROCEDURES MANUAL PURPOSE The Computer Operating Procedures Manual provides information and operating instructions related to the operating of the computer system The intended users are the operating staff of the computer operation department This manual should be site specific For established computer site with this manual already prepared there is no need to re produce it for individual system introduced into the site However please note that some parts of the manual for example the Hardware Configuration or the System Files section may need to be updated due to the introduction of new system It should be no
9. 000002 CLASS P MSGCLASS X MSGLEVEL 1 1 000003 RESTART XXXXXXXX 000004 REGION 8M Then submit job for rerun DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 10 5 CONTACT POINTS Office Hours User Support 0845 1730 Other Hours Ist line Support Staff 1 Phone No 1 Pager 1 2nd line Support Staff 2 Phone No 2 Pager 2 Maintenance Support Ist line Support Staff 3 Phone No 3 Pager 3 2nd line Support Staff 4 Phone No 4 Pager 4 DOCUMENTATION STANDARDS APPLICATION USER MANUAL FOR IMPLEMENTATION PHASE 9 9 APPLICATION USER MANUAL PURPOSE The purpose of the Application User Manual is to provide relevant information to the user department of the system implemented The intended users of the manual are the staff of the user department who will use the system The manual should contain detailed instructions in addition to an overall description of the procedures The detailed instructions should be made up of a set of standard instructions each part being complete in itself describing a logically distinct function e g procedures relating to a particular transactions The idea is that copies of different parts would be distributed to different persons whose duties are to carry out the particular work In other words the standard instructions would be able to form part of the job description of a post If th
10. 2 The salesman must no outstanding commission Delete a salesman EL Input A in Action 2 Input salesman detail Loss 3 Y upon confirmation _ automatically 1 Input U in Action i 2 Input Salesman Code 3 Change the Salesman details accordingly 1 Input D in Action 2 Input Salesman Code 3 Input Y upon confirmation 1 System will generate the i salesman code automatically i 1 The salesman must already exists C Messages and Action Messages Action Check if the wrong salesman ac ante PU EG Outstanding Commission exists i Error Withhold the deletion Pass the salesman cannot be deleted case to accounting dept for investigation 9 5 DOCUMENTATION STANDARDS APPLICATION USER MANUAL FOR IMPLEMENTATION PHASE 9 6 9 7 9 8 RUN SCHEDULE This part should provide detailed schedule for each periodic and ad hoc job to be triggered by users Those processes handled by Computer Operation Staff can be omitted here Information provided should include Event Scheduled date time Jobs macros used if any Estimated run time COMPUTER INPUT DOCUMENTS This part should provide detailed instructions for the preparation of computer input documents completed sample of each document should be given Document id Purpose When used Fill in instructions COMPUTER OUTPUT DOCUMENTS
11. 4 7 4 1 7 4 2 TABLE OF CONTENTS PURPOSE SCOPE REFERENCES DEFINITIONS AND CONVENTIONS SOURCE DOCUMENT DESCRIPTION List of Documents Document Description and Sample Document ID 1 Document ID 2 DATA FILE DESCRIPTION Data Structure Chart List of Files File Table Description File ID View ID 1 File ID View ID 2 SCREEN REPORT DESCRIPTION List of Screens Screen Layout Screen 1 Screen 2 List of Reports Report Layout Report 1 Report 2 7 2 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE DATA MANUAL In case the data is distributed across different machines the DATA FILE DESCRIPTION should be grouped under different platforms as illustrated below 6 1 6 2 6 3 6 3 1 6 3 2 6 3 3 74 7 2 7 3 7 3 1 7 3 2 7 3 3 DATA FILE DESCRIPTION DATABASE SERVER Data Structure Chart List of Files File Table Description File ID View ID 1 File ID View ID 2 DATA FILE DESCRIPTION APPLICATION SERVER Data Structure Chart List of Files File Table Description File ID View ID 1 File ID View ID 2 7 3 DOCUMENTATION STANDARDS DATA MANUAL FOR IMPLEMENTATION PHASE 7 3 7 3 1 7 3 2 7 4 7 4 1 7 4 2 SOURCE DOCUMENT DESCRIPTION List of Documents This section should list out the following information e Form No Purpose Form Description Document Description and Sample This section should briefly describe when the sourc
12. For all PROJECT records with END DATE on or before 2 years delete PROJECT HISTORY with PROJECT HISTORY PROJECT CODE PROJECT CODE delete PROJECT record Program Limits Unit Test Record 6 16 DOCUMENTATION STANDARDS DATA MANUAL FOR IMPLEMENTATION PHASE 7 DATA MANUAL 7 1 PURPOSE The Data Manual documents all computer data captured processed or produced by the system The various forms of data to be described in the manual include Source Document Source Document involved in the system for data input purpose e Data file Data which are kept in the system for future processing These can be conventional structured file or database Screen Report Screens Reports or documents which are output on printer external media or video display terminal Some development environments are capable of generating most of the information required in the Data Manual Project Teams are recommended to make the best of the document generating features of the tools so as to save the effort required in preparing and updating the document If none of the above forms of data is designed for the application system e g in the setting up of a pure LAN the preparation of Data Manual will not be required 7 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 7 2 TABLE CONTENTS DATA MANUAL 5 1 5 2 5 2 1 2 22 5 2 3 6 1 6 2 6 3 6 3 1 6 3 2 6 3 3 74 7 2 7 2 1 7 2 2 7 3 7
13. specification should include the information as described below Program ID This is the unique identification assigned to a program unit If the code is structured i e certain digit has a special meaning this should be documented in the Definitions amp Conventions of the program manual Mode This describes the operation mode of the program unit It may be any one of the following Online Update Batch Update Batch Report Online Enquiry e Online submit batch job e Sub routine Program Name A meaningful program name should be given for each program Description This is a narrative description of the tasks to be performed by the program Programming Environment This includes e Program Source Filename e Programming Language in use Version of Compiler development tools if the program is auto generated the program generation tool information should be specified here e Program size and run time main memory requirement if critical 6 4 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 4 6 6 4 7 6 4 8 6 4 9 6 4 10 Amendment History This describes the amendment made to the program specification All changes made to the program specification must be documented File Usage Following information are needed e Full name of the file table in use e File Usage Read Write Update Delete File Delete File Create etc For Client Server application th
14. types description for each record type should be provided Any data replication information should also be documented here For example if File A is an image or extracted summary of File B as at last month end this relationship needs to be documented in both File Description of File A and File B Noted that File A and File B may locate in same machine or in different machines in distributed data cases e Record Description This sub section should list out the record structure including field column name description size and format stored and display etc If there are multiple record types for a data file or REDEFINE clause is used there should be multiple record description for the data file Index Description This sub section can be omitted if the index are embedded in the data file and documented in the Record Row Description For each index of the corresponding data file table the field column involved and their sequence Ascending or Descending should be specified If any environment specific facility is applied for example cluster index or bit map index the information should also been documented 7 5 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE For example The Table Row Index Description for Oracle RDBMS table CODE DATA MANUAL 6 3 1 6 3 1 1 6 3 1 2 6 3 1 3 A CODE File Description CODE contains information tablespace for data user table spacel ta
15. 7 1 PURPOSE Laine M 7 1 7 2 TABLE CONTENTS Roof NIIS 7 2 7 3 SOURCE DOCUMENT 7 4 D c mentS eto een SR 7 4 732 Document Description and 1 7 4 7 4 DATA TILE DESCRIP HON sen 7 4 TAT Data Con arts 7 4 DSCOPDIGS aee re 7 4 143 File Tabl cse i t edente Ee rh 7 5 15 SCREEN REPORT DESCRIPTION Gaarden 7 8 TXE Screens Sase eee 7 8 T2 Seel 7 8 7 53 LASVOP Reports iiec t Ir ee AMEN EIN 7 8 Tow Report ad 7 8 8 APPLICATION OPERATION 8 1 8 1 8 1 8 2 TABLE OF CONTENDS erectis uto veau ERUNT UR acte 8 2 8 3 SYSTEM DESCRIPTION las 8 4 8 3 1 System OYVOrVIeW uoi eat a 8 4 5 944 Job Identihication DesCpIpUOTEo ssi os ed o totos rope en ee odi pens 8 4 825 System FOM sauehold sd 8 4 JORUN ON s 8 4 8 3 5 Summary of Program Description 8 4 8 4 SYSTEM MEDIA INPUT OUTPUT ee 8 4 841 p t Tips vage 8 4 4 25 MOM Tapes DISC Gare 8 4 8 5 SYSTEM OUTPUT REPORTS Lunsj e EE 8 5 8 6 OPERATIONS DESCRIPTION
16. Ancillary machine 6 3 Consumable and media 7 Summary of operation procedures 7 1 User procedures Required System Description 7 2 Terminal input procedures Screen Layout 8 Run schedule N A 9 Computer input documents N A 10 Computer output documents Report Layout 11 Terminal operating instructions N A C4
17. EM FILES BACKUP 10 2 MAGNETIC MEDIA CLEANING 11 SYSTEM ADMINISTRATION 11 1 LAN ADMINISTRATION 11 2 LAN USER ADMINISTRATION 11 3 OTHER APPLICATIONS ADMINISTRATION ANNEX A E MAIL SYSTEM ADMINISTRATOR GUIDE Ref No S8 B 4 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPENDIX C APPENDIX C CROSS REFERENCE BETWEEN OOM DELIVERABLES AND THE CORRESPONDING DOCUMENTS SECTIONS Document Section SYSTEM MANUAL Purpose 2 Scope 3 References 4 Definitions and Conventions 5 System summary 5 1 Objectives 5 2 System functions 6 Equipment configuration 6 1 Computer hardware 6 2 Ancillary machine 6 3 Consumable and media 7 Software Inventories 7 1 Inventory of application programs 7 2 Inventory of system software 7 3 Inventory of software package 8 Security and backup 9 Database administration 10 System constraints and limitations 11 Function point analysis wm 7 OOM Deliverables N A N A N A N A Objectives of Required System Description Use Case Model Selected Technical System Option List of Components and Classes Selected Technical System Option Audit Control and Security Requirements N A Constraints List Function Point Analysis C 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE Document Section PROGRAM MANUAL Purpose 2 Scope 3 References 4 Definitions and Conventions 5 Program List 6 Program Specifications DATA MANUAL Purpose 2 Scope 3 Referen
18. ENTS 1 PURPOSE Sc 1 1 2 SCOPE Ue 2 1 3 REFERENCES eee dende 3 1 3 1 STANDARDS SG 3 1 32 OTHER REFERENCES upassende 3 1 4 DEFINITIONS AND 8 2 2 etes toss sten 4 1 4 1 DEFINITION S jus aan 4 1 4 2 CONVENTIONS a comet padi au fads 4 1 5 URN EPOR UE oise 5 1 5 1 PURPOSE see 5 1 3 2 TABLE OF CONTENTS Quentin astutus 5 2 5 3 SYSTEM SUMMAR Y rona t Se 5 3 MEET I 5 3 552 System FUNCIONS sva 5 3 5 4 EQUIPMENT CONFIGURATION 5 3 54 1 Computer Hardware eaei iee ed Gd erri e 5 4 542 Amcillary Machinery uis scie emt e ees eis a ee io eia 5 4 54 3 Consumable and Medis aa SET 5 4 5 5 SOFTWARE INVENTORIES 5 5 5 5 1 Inventory of Application 5 5 5 5 2 Inventory of System Software eene P Pee eR adea 5 5 5 5 3 Inventory of Software Package osos neve sette eod D 5 6 5 6 SECURITY AND BACKUP E ex stade aurea 5 6 5 7 DATABASE ADMINISTRATION 4 0888 5 7 5 8 SYSTEM CONSTRAINTS AND LIMITATIONS eere 5 7 5 9 FUNCTION
19. G DOCUMENTS SECTIONS DOCUMENTATION STANDARDS PURPOSE FOR IMPLEMENTATION PHASE 1 PURPOSE The major purposes of this documentation are to define the documentation required to be prepared in the Implementation Phase and e set out the standards of the stipulated documentation 1 1 DOCUMENTATION STANDARDS SCOPE FOR IMPLEMENTATION PHASE 2 SCOPE These standards laid down the purpose and content of the following manuals a System Manual b Program Manual c Data Manual d Application Operation Manual e Application User Manual f Computer Operating Procedures Manual These standards will be used by application development teams as well as application maintenance teams in preparation and revision of implementation documents Application end users involved in preparation of Application User Manual may also refer to the standard for Application User Manual Documentation of all administrative systems should follow these standards 2 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE De REFERENCES 3 1 STANDARDS SSADM V4 2 Documentation Standards S4 3 2 OTHER REFERENCES Resources Estimation Guide G19 REFERENCES 3 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 4 DEFINITIONS AND CONVENTIONS 4 DEFINITIONS Nil 4 2 CONVENTIONS Nil DEFINITIONS AND CONVENTIONS 4 1 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 5 1 SYSTEM MANUAL PUR
20. L Purpose N A 2 Scope N A 3 References N A 4 Definitions and Conventions N A 5 Program List N A 6 Program Specifications Process Module DATA MANUAL Purpose N A 2 Scope N A 3 References N A 4 Definitions and Conventions N A 5 Source document description N A 6 Data file description Required System LDS Required System Entity Description 7 Screen Report description Screen Layout Report Layout A 2 DOCUMENTATION STANDARDS APPENDIX A FOR IMPLEMENTATION PHASE Document Section SSADM Deliverables APPLICATION OPERATION MANUAL Purpose N A 2 Scope N A 3 References N A 4 Definitions and Conventions N A 5 System description 5 System overview Required System Overview of Required System Description 5 2 Job identification description N A 5 3 System flow N A 5 4 Job run flow N A 5 5 Summary of program description Process Module 6 System media input and output N A 7 System output reports N A 8 Operations description N A 9 Run job specification N A 10 Error handling N A A 3 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE Document Section APPLICATION USER MANUAL 1 2 Purpose Scope References Definitions and Conventions System summary 5 1 Objectives 5 2 System functions Equipment configuration 6 1 Computer hardware 6 2 Ancillary machine 6 3 Consumable and media wm APPENDIX A SSADM Deliverables N A N A N A N A N A Function Definition Selecte
21. NPUT OUTPUT This part should describe in detail the nature of input and output media Input Tapes Discs This section should describe the media required for input Output Tapes Discs This section should describe the media required for output 8 4 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 8 5 8 6 8 7 SYSTEM OUTPUT REPORTS This part should describe in brief all reports output from the Application System The reports are classified as Daily Reports e Weekly Reports e Monthly Reports e Other Reports For example such as Microfilm OPERATIONS DESCRIPTION This section should describe the Operation schedule and service hours of the Application System The schedule are classified as e On line Schedule e Batch Schedule e Adhoc Schedule RUN JOB SPECIFICATIONS This part should describe by job the specifications of all jobs processed It includes the following information Jobname and Job Function e Estimated Run Time e Parameters Requirement Limitation e Program Sequence Restart Procedures e Output Listings 8 5 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 8 8 ERROR HANDLING This part should describe the following Procedure for handling Job failure and Job restart Project Team is required to provide detail and clear cut instruction on this topic e Example on Job restart Procedure e Cont
22. NTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 5 3 Example 3 Batch Update and Report A batch update and report program called by a parameter input program Program ID SSMPURG Mode Batch Update Program Name Purge outdated project support information Description Purge outdated project support information and print a detail report showing the purged project history Program Environment i Revision Date 6 14 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE Input Parameters Report Groups pod Dac COO QE Sequence Break 2 Broject Code 12 3 Project Event m asin Page Break Retrieval Logic for report For each PROJECT with PROJECT STATUS Completed and PROJECT END DATE on or after I year before ordered by END DATE CODE Retrieve STAFF with CODE PROJECT SUPPORT STAFF Retrieve TEAM with TEAM CODE PROJECT TEAM CODE Project Name PROJECT DESCRIPTION Staff Code STAFF CODE Staff Name STAFF NAME Project Team TEAM DESCRIPTION Retrieve PROJECT HISTORY with CODE PROJECT CODE ordered by PROJECT HISTORY EVENT DATE Event Date PROJECT HISTORY EVENT DATE Event if PROJECT HISTORY EVENT is 57 then Start A then 6 15 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE Processing Logic for Purging
23. Office of the Government Chief Information Officer DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE S8 Version 3 7 Jul 2012 OThe Government of the Hong Kong Special Administrative Region The contents of this document remain the property of and may not be reproduced in whole or in part without the express permission of the Government of the HKSAR COPYRIGHT NOTICE 2008 by the Government of the Hong Kong Special Administrative Region Unless otherwise indicated the copyright in the works contained in this publication is owned by the Government of the Hong Kong Special Administrative Region You may generally copy and distribute these materials in any format or medium provided the following conditions are met a the particular item has not been specifically indicated to be excluded and is therefore not to be copied or distributed b the copying is not done for the purpose of creating copies for sale c the materials must be reproduced accurately and must not be used in a misleading context and d the copies shall be accompanied by the words copied distributed with the permission of the Government of the Hong Kong Special Administrative Region All rights reserved If you wish to make copies for purposes other than that permitted above you should seek permission by contacting the Office of the Government Chief Information Officer DOCUMENTATION STANDARDS CONTENTS FOR IMPLEMENTATION PHASE TABLE OF CONT
24. POINTS ANALYSIS ges 5 8 6 PROGRAM MANUAL ordo 6 1 6 1 PURPOSE E 6 1 6 2 TABLE OF CONTENTS gudenes ui 6 2 6 3 PROGRAM EN ES M a eO 6 3 6 4 PROGRAM SPECIFICATIONS iciesseecosesic eee vn PLIN 6 4 Od Program avse 6 4 ANSA 6 4 0 4 3 Program Ne suse 6 4 644 Description iiie E set n easa aa E aE 6 4 645 Programming s ose oot esten te ss 6 4 6 4 6 Amendment EDSEOFy ne ete abe ocior ees bove teg 6 5 GAT FEET 6 5 OAS gt iae aao wea ao ei eb a 6 5 6 4 9 Screens Used eee desto ere redet 6 5 DOCUMENTATION STANDARDS CONTENTS FOR IMPLEMENTATION PHASE 6 4 10 Proc ssing LOGIC ie tetro eh esti a 6 5 GALLI oe o 6 6 64 12 Programi Itin dags 6 6 6113 ULTRA 6 7 64 14 Program Listing 6 7 6 5 UB EIE TIONG EDR 6 8 6 5 1 Example 1 General SttuctUte ec eren ene speci adeo hi er RU sie 6 8 6 5 2 Example 2 Client Server Online 6 11 6 5 3 Example 3 Batch Update and 6 14 7 DATA MANUAL 55566 a iais 7 1
25. POSE The purpose of System Manual is to provide an overview of the system by listing out in brief the programs data files equipment clerical procedure computer operation procedure etc Reader interested in specific area may refer to the corresponding manuals Data Manual Program Manual etc The major readers of System Manual are the staff responsible for maintaining the application system The major input for the preparation of System Manual is the System Analysis and Design Report prepared during the System Analysis and Design Phase see Appendix A with necessary refinement and elaboration of details 5 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 5 2 TABLE OF CONTENTS SYSTEM MANUAL 5 1 5 2 6 1 6 2 6 3 74 7 2 7 3 10 11 TABLE CONTENTS PURPOSE SCOPE REFERENCES DEFINITIONS AND CONVENTIONS SYSTEM SUMMARY Objectives System Functions EQUIPMENT CONFIGURATION Computer Hardware Ancillary Machinery Consumable and Media SOFTWARE INVENTORIES Inventory of Application Programs Inventory of System Software Inventory of Software Package SECURITY AND BACKUP DATABASE ADMINISTRATION SYSTEM CONSTRAINTS AND LIMITATIONS FUNCTION POINT ANALYSIS 5 2 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 5 3 5 3 1 5 3 2 5 4 SYSTEM SUMMARY Objectives This section should provide statement of objectives as agreed in the Project Request Feasibility Study Repor
26. Procured Hardware amp Software Testings amp Installation User Quality Assurance Resilience Test Plan Acceptance Specification and Results Testing Trained User Training amp GCN Connection Production Handover Document Application User Manual 7 Computer Operating Procedures Manual System Manual 9 Computer Systems Production Use Project Project Evaluation Report Evaluation Review Final deliverables of the project Ref No S8 B 1 DOCUMENTATION STANDARDS COMPUTER OPERATING FOR IMPLEMENTATION PHASE PROCEDURES MANUAL FOR GOA PROJECTS THE PROPOSED TABLE OF CONTENTS FOR SYSTEM MANUAL APPLICATION USER MANUAL AND COMPUTER OPERATING PROCEDURES MANUAL ARE AS FOLLOWS DOCUMENT SECTION GOA Deliverables SYSTEM MANUAL 1 PURPOSE 2 SCOPE 3 REFERENCES 4 DEFINITIONS AND CONVENTIONS 5 SYSTEM SUMMARY 5 OBJECTIVES 5 2 SYSTEM FUNCTIONS 6 EQUIPMENT CONFIGURATION 6 1 COMPUTER HARDWARE 6 2 ANCILLARY MACHINERY N A 6 3 CONSUMABLE AND MEDIA N A details are to be included in Annex A Resilience Design and Recovery Procedures 7 SOFTWARE INVENTORIES 7 1 INVENTORY OF APPLICATION PROGRAMS N A 7 2 INVENTORY OF SYSTEM SOFTWARE 7 3 INVENTORY OF SOFTWARE PACKAGES 8 SECURITY AND BACKUP 9 DATABASE ADMINISTRATION N A 10 SYSTEM CONSTRAINTS AND LIMITATIONS 11 FUNCTION POINT ANALYSIS N A ANNEX A RESILIENCE DESIGN AND RECOVERY PROCEDURES Ref No
27. TEM MEDIA INPUT AND OUTPUT 6 1 Input Tapes Discs 6 2 Output Tapes Discs 7 SYSTEM OUTPUT REPORTS 7 1 Daily Reports 7 2 Weekly Reports 7 3 Monthly Reports 7 4 Other Reports 8 OPERATIONS DESCRIPTION 8 1 On line Schedule 8 2 Batch Schedule 8 3 Adhoc Schedule 9 RUN JOB SPECIFICATIONS 9 1 Job 1 9 2 Job 2 APPLICATION OPERATION MANUAL 8 2 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPLICATION OPERATION MANUAL 10 10 1 10 2 10 3 10 3 1 10 3 2 10 4 10 5 ERROR HANDLING Critical Errors Handling Non Critical Errors Handling Other Errors Handling Procedures Input Tape Error Handling Error Message Handling Job Restart Procedure Contact Points 8 3 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 8 3 8 3 1 8 3 2 8 3 3 8 3 4 8 3 5 8 4 8 4 1 8 4 2 SYSTEM DESCRIPTION System Overview This section should briefly describe the major functions provided by the application system Job Identification Description This section should describe the naming convention for a job System Flow This section should document the flow of the system in which all programs input and output media are shown Job Run Flow This section should describe the sequence for all separate jobs using Job Run Flow diagram Summary of Program Description This section should provide a brief summary about the job program s description SYSTEM MEDIA I
28. act Persons for User and Project Team 8 6 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 8 9 ILLUSTRATION Below is an example of the content of Application Operation Manual 1 PURPOSE The purpose of this manual are provides relevant information on the various functions on the computer system serves as a guideline for Control Staff of OGCIO s Computer Operations Division on the operation procedures for job preparation submission and monitoring report checking and dispatching and restart procedures 2 SCOPE This document define the operation procedure for System Name Application System It should be reference for all operation staff involved in the System Name application operation 3 REFERENCES 3 STANDARDS Documentation Standards for Implementation Phase S8 3 2 OTHER REFERENCES Nil 8 7 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 4 DEFINITIONS AND CONVENTIONS 41 DEFINITIONS Nil 4 22 CONVENTIONS Nil 5 SYSTEM DESCRIPTION 5 1 SYSTEM OVERVIEW The System Name performs the major function on It was an integrated system of the following sub systems e Driving Offence Points Record Processing Drivers Licensing Sub system 3 Sub system 4 5 1 1 Driving Offence Points Record Processing The explanation on functions performed by sub system 5 1 2 Drivers Li
29. blespace for index CODE INDI user index spacel Record Description Ascending Ascending Sr KSS 7 6 DOCUMENTATION STANDARDS DATA MANUAL FOR IMPLEMENTATION PHASE For example The Record Description for Index Sequential File with multiple record type 6 3 1 MASTER 6 3 1 1 File Description A MASTER file contains information Header Record is used to The Tx Record are used to Blocking Factor Record Size if record size for each record type is different the record size will be documented in Record Description 6 3 1 2 Record Description 6 3 1 2 1 Record Type Header Record Field Key Description Picture Output Remarks i i Format REC TYPE Y Record Type X 1 for 2 Record Dae in YYMMDD Details 50 1 N E AA header record In the above case the key is embedded in the data file and thus the Index Description is omitted 7 7 DOCUMENTATION STANDARDS DATA MANUAL FOR IMPLEMENTATION PHASE 7 5 7 5 1 99 2 7 5 3 7 5 4 SCREEN REPORT DESCRIPTION List of Screens This section should list out all screen ID and description if appl
30. censing The explanation on functions performed by sub system 5 1 3 Sub system 3 8 8 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 5 2 JOB IDENTIFICATION DESCRIPTION PXXZZZnn is the Job Name where P Production job XX Job Identification of System Name 777 Jobname Nature of the Job Update SRT Sort MRG Merge PRT Prnt HKP gt Housekeeping ADC Adhoc nn The assigned Job number 01 02 99 etc 8 9 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPLICATION OPERATION MANUAL 5 3 SYSTEM FLOW 5 3 1 Sub system 1 System Flow RM PN FILE MONTHLY STATISTIC PRGM1000 RINT AND ARCHIVE SYSTEM UBLIC LOG la gt PUBLIC CONTROL FILE uM i DAILY PUBLIC LOG CONTROL REPORT P v DCAMS MERGE PUBLIC LOG DAILY gt MERGED PUBLIC LOG PUBLIC LOG DCAMS ELETE TEMP SKUP ERGED FILE TO RCHIVE FILE gt V NAD DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 54 JOB RUN FLOW 5 4 Job Run Flow Daily Job Run after CICS service c
31. ces 4 Definitions and Conventions 5 Source document description 6 Data file description 7 Screen Report description RE APPENDIX C OOM Deliverables N A N A N A N A N A Use Case Model Business Rules Class Model Object Sequence Diagrams Component Dependency Model N A N A N A N A N A Required System LDS Required System Entity Description Screen Layout Report Layout C 2 DOCUMENTATION STANDARDS APPENDIX C FOR IMPLEMENTATION PHASE Document Section OOM Deliverables APPLICATION OPERATION MANUAL Purpose N A 2 Scope N A 3 References N A 4 Definitions and Conventions N A 5 System description 5 System overview Required System Overview of Required System Description 5 2 Job identification description N A 5 3 System flow N A 5 4 Job run flow N A 5 5 Summary of program description N A 6 System media input and output N A 7 System output reports N A 8 Operations description N A 9 Run job specification N A 10 Error handling N A C 3 DOCUMENTATION STANDARDS APPENDIX C FOR IMPLEMENTATION PHASE Document Section OOM Deliverables APPLICATION USER MANUAL Purpose N A 2 Scope N A 3 References N A 4 Definitions and Conventions N A 5 System summary 5 1 Objectives Objectives of Required System Description 5 2 System functions Use Case Model 6 Equipment configuration Selected Technical System 6 1 Computer hardware Option 6 2
32. d Technical System Option 7 Summary of operation procedures 7 User procedures Required System Description 7 2 Terminal input procedures Screen Layout 8 Run schedule N A 9 Computer input documents N A 10 Computer output documents Report Layout 11 Terminal operating instructions N A A 4 DOCUMENTATION STANDARDS COMPUTER OPERATING FOR IMPLEMENTATION PHASE PROCEDURES MANUAL APPENDIX B GOA PROJECTS Due to project characteristics only three manuals will be produced in GOA Projects as final documentation for Implementation Phase The Application User Manual and Computer Operating Procedures Manual would be used as cook books for daily operation whereas System Manual would be treated as the primary reference materials for future system maintenance The table of contents of the three manuals are stated in the following pages In order to produce the above three manuals during Implementation Phase the following SDLC major steps and interim deliverables should be followed and produced SDLC Deliverables Guidelines Major Steps Techniques Physical User requirements and existing configuration G35 G41 System Vertical Network Requirement Report G43 G44 Design Horizontal Network Requirement Report E mail System Implementation Migration Proposal Site Preparation Requirement Report Network Installation Guide Router Configuration Proposal Master Activity Plan System Prepared Site Integration
33. e File Location Database Server Application Server Client etc and the way of accessing the file table e g using remote procedure call should be documented Input Parameters This describes the format of the parameters used as input to the program If the program is a subroutine a separate paragraph on the output parameters messages returned should also be given Screens Used This is a list of all screen window identifier involved The screen layouts are placed in the Screen Report Section of the Data Manual Processing Logic This provides a narrative description on the processing steps Sufficient details should be given for the programmers to complete coding and testing of the program The followings should be elaborated where applicable e Normal start e Special restart e Program options e Validity check Screen Window Navigation e Editing criteria 6 5 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 4 11 6 4 12 e Arithmetic computation and logical manipulation End procedures Events and the corresponding actions including control break for reports e Message displayed Tabular form and decision table should be used if appropriate External Reference This describes any library procedure subroutine called within the program These include special purpose procedures written for the applications in house library procedures and software library procedures supplied b
34. e No Description Date of Installation In case of client server application the location of the system software should also be specified 5 5 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 3 5 3 5 6 Inventory of Software Package This inventory should include the following information for all software package employed within the application system e Software ID Name e Version Release No e Description e Date of Installation In case of client server application the location of the system software should also be specified SECURITY AND BACKUP This part describes the backup strategy and any security control in use Information provided should include to control the access of computer generated output documents Database This sub section should describe in detail the frequency of backup Full Incremental Database Backup backup media and recycle period System backup This sub section should describe in detail the frequency of Full Incremental System Backup backup media and recycle period Recovery This sub section should describe the level of recovery services provided After system failure the application system may either be totally recovered within a short period of time or be partially recovered within a considerable period of time or totally irrecoverable within a considerable period of time Fall back This sub section should document in detail the Fall back procedures pr
35. e application provides online facilities for the user a part on the terminal operating procedures should also be documented Normally it is the user responsibility to prepare the Application User Manual Project team should provide adequate assistance to the user in preparing the manual 9 1 DOCUMENTATION STANDARDS APPLICATION USER MANUAL FOR IMPLEMENTATION PHASE 9 2 TABLE OF CONTENTS TABLE OF CONTENTS 1 PURPOSE 2 SCOPE 3 REFERENCES 4 DEFINITIONS AND CONVENTIONS 5 SYSTEM SUMMARY 5 1 Objectives 5 2 System Functions 6 EQUIPMENT CONFIGURATION 6 1 Computer Hardware 6 2 Ancillary Machinery 6 3 Consumable and Media 7 SUMMARY OF OPERATION PROCEDURES 74 User Procedures 7 2 Terminal Input Procedures 8 RUN SCHEDULE 9 COMPUTER INPUT DOCUMENTS 10 COMPUTER OUTPUT DOCUMENTS 11 TERMINAL OPERATING INSTRUCTIONS 9 2 DOCUMENTATION STANDARDS APPLICATION USER MANUAL FOR IMPLEMENTATION PHASE 93 9 4 9 5 9 5 SYSTEM SUMMARY Replicate from System Manual This part summarizes what the system provides for the user departments Refer to Chapter 5 for details EQUIPMENT CONFIGURATION Replicate from System Manual This part should provide the equipment in use for the application system Refer to Chapter 5 for details SUMMARY OF OPERATION PROCEDURES I User Procedures This section should contain procedures description and instructions in detail covering areas like batching of input data contr
36. e document is used and what it is used for Sample of the input document should be attached In additional to the blank document filled in document may also be included DATA FILE DESCRIPTION The following items are the minimum information that needs to be included in the Data Manual Depending on the implementation platform additional information may be needed For example some database management provides constraint rule reinforcement facility which should be documented in this section Data Structure Chart The Data Structure Chart database schema is used to show the relationship among files tables or other groups of data If the data are distributed across different hardware platforms separate data structure chart should be provided for each platform List of Files This section should list out the following information e File ID Type E g DB2 VSAM or Oracle Table e Description If the data are distributed across different hardware platforms separate list of file should be provided for each platform 7 4 DOCUMENTATION STANDARDS DATA MANUAL FOR IMPLEMENTATION PHASE 7 4 3 File Table Description File Description This sub section should describe the detailed information of the data file table including file table physical name narrative description and other implementation related information e g tablespace assigned segment blocking factor etc In case the file contains multiple record
37. f the application system Information provided should include e Project category e List of logical functions and their function counts for each of the following function types External Input IT External Output OT External Inquiry QT Internal Logical File FT External Interface File ET Total unadjusted function points 9 Assessment on the degrees of influence Adjustment factor Overall adjusted function points 5 8 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 6 1 PROGRAM MANUAL PURPOSE The program manual contains the detailed program specification of all programs used within the application system During Implementation Phase the program specification is prepared by the analyst and used by the programmer in program coding The program specification also serve as a useful reference for future maintenance activities Some development environments for example Viasoft SmartDoc for Mainframe COBOL Oracle Designer 2000 for Unix Oracle are capable of generating program documentation Project teams may make use of the generated documentation whenever appropriate in the preparation of this manual so as to minimize the effort required in preparing and updating the program manual Project team should tailor the program manual to fully describe any specific characteristics e g event handling message passing of the software development environment If no new pro
38. gram is developed for the application system the preparation of Program Manual will not be required 6 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 6 2 TABLE OF CONTENTS PROGRAM MANUAL 6 1 6 2 TABLE OF CONTENTS PURPOSE SCOPE REFERENCES DEFINITIONS AND CONVENTIONS PROGRAM LIST PROGRAM SPECIFICATIONS Program ID 1 Program ID 2 6 2 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 6 3 PROGRAM LIST PROGRAM MANUAL This part should provide a list of program specifications contained in the program manual The program specifications may be grouped under different function groups For example 9 145 A Online Input Program ID Description B Reports amp Enquiry SSMPROJ Support Project Maintenance SSMSTFF Support Staff Maintenance Program ID Description C Batch Processing SSLPROJ Support Project List SSLSTFF Support Staff List Program ID Description SSMPURG Purge outdated information or the program list may be sorted in alphabetical order 5 PROGRAM LIST Program ID Description SSLPROJ Support Project List SSLSTFF Support Staff List SSMPROJ Support Project Maintenance SSMPURG Purge outdated information SSMSTFF Support Staff Maintenance 6 3 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 4 6 4 1 6 4 2 6 4 3 6 4 4 6 4 5 PROGRAM SPECIFICATIONS Each program
39. icable by screen ID or functional group sequence Screen Layout This section should give a collection of all screen layouts as mentioned in the List of Screen List of Reports This section should list out all report ID and description if applicable by report ID or functional group sequence Report Layout This section should give a collection of all the Computer Output reports pre printed form etc layouts as mentioned in the List of Report 7 8 DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 8 APPLICATION OPERATION MANUAL 8 1 PURPOSE The purpose of the Application Operation Manual AOM is to provide relevant information to the computer operation staff of the system implemented It should document in detail the instructions of all the work to be performed by the computer operation staff in running the application system The work handled by end user should be documented in the Application User Manual If no additional activity is introduced to the computer operation staff after the application system is implemented the preparation of AOM will not be required 8 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 8 2 TABLE OF CONTENTS TABLE OF CONTENTS 1 PURPOSE 2 SCOPE 3 REFERENCE 4 DEFINITIONS AND CONVENTIONS 5 SYSTEM DESCRIPTION 5 1 System Overview 5 2 Job Identification Description 53 System Flow 5 4 Job Run Flow 5 5 Summary of Program Description 6 SYS
40. ice In case of job failure and recovery fails due to problem on recovery procedure Project Team should update amend the AOM in the following day 10 1 CRITICAL ERRORS HANDLING When a job aborts refer to Run Job Specifications of the AOM and follow the procedures to prepare for restart or recovery If a critical job fails to recover Production Control Staff is required to contact Support Team of the Application for advice Also to record all information about job failure such as time date and actions performed for further investigation 10 2 NON CRITICAL ERROR HANDLING jobs are considered non critical unless otherwise specified All non critical jobs should have their own recovery procedure Step by step and job by job If the procedure does not work and cause failure on job recovery Production Control staff should follow up the case to inform Support Team to amend update the AOM as soon as possible DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPLICATION OPERATION MANUAL A 1 Verify the parameter values 2 Correct errors 3 Resubmit the job 10 3 2 PXXZZZ0l l Error in DUMMY or VOLSER i I parameter values 2 Duplicate Volume Serial Numbers ir E PXXO001 E020 Empty System File i Check System File content E030 E035 E038 PXXZZZ0A PXX002 E020 Records not i i
41. lose down PXXZZZnn PXXZZZ01 PXXZZZ02 PXXZZZ03 PXXZZZ04 PXXZZZ05 i UN END ec PXXZZZ06 PXXZZZ07 PXXZZZ08 PXXZZZ09 TN END Na DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPLICATION OPERATION MANUAL 5 4 2 Job Run Flow Weekly Job Run after CICS service close down Run after completion of all DAILY JOBS PXXZZZ10 PXXZZZ11 PXXZZZ12 PXXZZZ13 VA T aa EN END PXXZZZ14 PXXZZZ15 S PXXZZZ16 PXXZZZ17 PXXZZZ18 PXXZZZ19 PXXZZZ20 PXXZZZ 1 JE oc PX END NG SA usn DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 5 5 SUMMARY OF PROGRAM DESCRIPTION 6 SYSTEMS MEDIA INPUT AND OUTPUT 6 1 INPUT TAPES DISCS PXXUPTan XOOOOC YYY ZZ Update Enquiry 6 2 OUTPUT TAPES DISCS roe m Data ro Jebname Data Set Name Fe i Description Description Medium Freq No of 1 Medium Ne of Retention DOCUMENTATION STANDARDS APPLICATION OPERATION MANUAL FOR IMPLEMENTATION PHASE 7 74 7 2 7 3 7 4 7 5 8 2 8 3 SYSTEM OUTPUT REPORTS DAILY REPORTS Name In Use Yes No PXXUPTnn ID 1 Update SIP No Report 1 EEE Da
42. ocedure in case system failure occurred and before it is being recovered This sub section should document in detail the system security profile and data protection measurement on system functions This sub section should document the procedures used for the management of system software and application programs Disaster This sub section should describe in detail the Disaster Recovery Recovery Plan and Procedures 5 6 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 5 7 5 8 DATABASE ADMINISTRATION This part should describe any database administration procedures that are carried out by the project team such as e database re organization e table extension e table space extension e index re build Those procedures carried out by the computer operation staff should be documented in the Application Operation Manual This part may be omitted if there is no such administration activities for this application SYSTEM CONSTRAINTS AND LIMITATIONS This part should describe item by item the system constraints and limitations that may affect operation Information may include e Transaction volume e Frequency e Logical sequence of events Period of retention of data e Timing e Major service level indicators 5 7 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 5 9 FUNCTION POINTS ANALYSIS This part should document the detailed Function Point Analysis information o
43. ol of documents actions on specific events error amendments etc Clerical procedures that will directly trigger a computer process or is being triggered by a computer process should be documented Below is an example of the User procedure to handle complaint from customer on incorrect invoice outstanding balance User Role Report Ref Event occurred randomly Customer Report the detail information in Form CL001 Service Complaint Log and pass to A C dept Representative A C Supervisor Acknowledge complaint log Perform Customer Ledger Screen 5 013 Enquiry to investigate the situation METT STIG The investigation result was logged HR Form CL001 Customer Feedback the result to customer Service Representative MA prepare adj tx input ADJO10 Computer Input Perform Adjustment Tx entry Screen SCMOI5 Staff process according to A C supervisor instruction L Print Adj update report Report SCP040 A C Supervisor Check the Adj update report pur 7i 9 3 DOCUMENTATION STANDARDS APPLICATION USER MANUAL FOR IMPLEMENTATION PHASE An alternative way to document the User Procedures is using diagram such as following Invoice Balance Customer Service eceive complaint fro customer Incorrect Representative A C Supervisor Report the detail Acknowledge the information in the complaint log complaint log IVG Supervisor Log the Perform Customer Inve
44. provide similar information as stated in 5 4 1 of any ancillary machinery used such as Data entry equipment Guillotining equipment Decollation equipment Others Consumable and Media This section should describe the consumable and media required by the application system These include Magnetic media total number capacity usage labeling retention disc tape policy Stationery give the estimated annual consumption of each type cards paper of stationery required 5 4 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 5 5 5 5 1 5 5 2 SOFTWARE INVENTORIES This part should summarize all software that is required for the operational running of the system Detailed documentation of the application programs should be given in the Program Manual The objective of this chapter is to enable the future Maintenance and Enhancement Team to be aware of the scope and inter relationship of functions and programs and files Inventory of Application Programs This inventory should be organized in function group system module order and should include the following details e Program ID Name e Functions of the program In case of client server application the location of the program e g Database Server Application Server Client etc should also be specified Inventory of System Software This inventory should include the following details e Software ID Name e Version Releas
45. ption The program create update delete Program Environment Change Revision Description Revision Date Number 22 cc sess LU NIME 2 1 Amend the screen layout to adda flag 1 1 5 7 1995 i represents whether it is an ASA project 6 8 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE Input Parameters Field Navigation Action Only allow D SU values Project Code if Action System Assign unique identifier 9 9 format else Accept user input Project Code read PROJECT using input Project Code display error message 0001 if record not found display Project Details if Action D skip input to Confirm Flag User Dept Code User Dept Code entered must already exist in the USERDEPT Display UD NAME as Department Confirm Flag ES i if Action Insert record else 6 9 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE Message Used Message ID Message Text External Reference Procedure ibrary Parameters Remarks Filename format EI i date 9 6 Commonly used sub status i X 1 function Program Limits 1 The maximum no of Team Lookup is 999 Unit Test Record
46. stigation idis Sme Result edger Enqiury Customer Service Representative Feedback to customer A C Supervisor YES Prepare A C adj tx input Computer Input Staff Input A C adj tx C onm P NO Process If A C Adj isneeded Symbol in use Computer Input Staff Print A C Adj Update Report Manual process A C Supervisor Decision Complaint from Check the A C customer handled Adj Update Report 9 4 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE APPLICATION USER MANUAL 9 5 2 Terminal Input Procedures This section should specify the instructions for carrying out the application functions transactions via the video display terminal covering data entry error corrections and actions on specific events Screen formats should be included The validation rules for critical data item should be documented A list of error messages that the system may generate their meanings and the corresponding corrective actions should be fully documented Below is an example of Terminal Input Procedures of a simple master file maintenance Maintain Salesman Information A Screen Layout B Instructions salesman i Change salesman details 1 The salesman must already exists
47. t or System Analysis and Design Report System Functions This section should document the functions provided by the application system The following information should be provided for each function Function ID Name e Function Description Mode e g Online Batch Enquiry Update e Frequency of use e Special Service Level Requirement e g Response time service duration EQUIPMENT CONFIGURATION This part should provide the equipment configuration which describes the inter relationship among all hardware components including communication network Diagram may be used to supplement the narrative description if applicable If the equipment configuration is common to projects run on the same computer system and they are documented separately and centrally the corresponding documents should be stated for reference 5 3 DOCUMENTATION STANDARDS SYSTEM MANUAL FOR IMPLEMENTATION PHASE 5 4 1 5 4 2 5 4 3 Computer Hardware This section should e list manufactures model number serial number device names for all devices e list relevant speeds and or capacities for devices including communication lines where applicable e list types of lines note whether lines are private leased dial up multidropped etc e document the location of in house and remote devices e provide a simple diagram to represent the relationships among the above hardware if appropriate Ancillary Machinery This section should
48. ted that the manual is not intended to be a complete replacement of the formal technical publication as issued by the manufacturer Information and instructions documented in the manual would be specific to the installation and should take precedence over the manufacturer s counterparts When the system is to be operated by the end users themselves the detailed procedures would be explained in the Application User Manual instead 10 1 DOCUMENTATION STANDARDS FOR IMPLEMENTATION PHASE 102 TABLE OF CONTENTS COMPUTER OPERATING PROCEDURES MANUAL 5 1 5 1 1 22 5 2 5 3 5 4 6 1 6 2 6 3 6 4 6 5 6 6 74 7 2 7 3 7 4 TABLE CONTENTS PURPOSE SCOPE REFERENCES DEFINITIONS AND CONVENTIONS COMPUTER SYSTEM INFORMATION Hardware Configuration Computer Hardware Configuration Communication Network Configuration Hardware Components Description System Software Environment Systems Files COMPUTER SYSTEM OPERATING PROCEDURES NORMAL CASE Powering On Off Switching On Off The Hardware Components Loading Closing Down the Computer System Communication Network Media Placement Scheduling amp Spooling System Prompts Exceptions Handling COMPUTER SYSTEM OPERATING PROCEDURES ABNORMAL CASE Taking System Dumps Checking the Air Conditioning System Power Supply System Fault Reporting Procedures First Line System Crash Communication Faults Diagnosis 10 2 DOCUMENTATION STANDARDS COMPUTER OPERATING
49. y the manufacturers but exclude calls generated by the compiler system Procedure Function Routine ID Library filename e Input Output Parameters e Remarks For client server situation the location of remote procedure should be documented in Remarks Program Limits This describes areas where the capability of the program is likely to be limited by design including e sequence of input data e volume restriction e storage limitation e limitation on utility program usage maximum in store arrays e others 6 6 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 4 13 6 4 14 Unit Test Record For each unit test performed on the program the following should be given e Test number e Test Description Expected Actual Result e Test data generating procedures if applicable e Test run procedures if applicable Program Listing The latest version of all the programs should be kept in softcopy for future reference and maintenance Depending on the development environment project team should decide whether hardcopy of the program source are included in the Program Manual 6 7 DOCUMENTATION STANDARDS PROGRAM MANUAL FOR IMPLEMENTATION PHASE 6 5 ILLUSTRATION 6 5 1 Example I General Structure This example is used to illustrate the structure of program specification Program ID SSMPROJ Mode Online Update Program Name Maintain Support Project Information Descri
Download Pdf Manuals
Related Search