Professional Development  > Other Standards & Guidelines  > Documentation Standards for Implementation Phase
 
 

The major purposes of this documentation are :

  • to define the documentation required to be prepared in the Implementation Phase ; and

  • to set out the standards of the stipulated documentation.

These standards laid down the purpose and content of the following manuals:

  • System Manual

  • Program Manual

  • Data Manual

  • Application Operation Manual

  • Application User Manual

  • Computer Operating Procedures Manual

The System Manual provides an overview of the system including the system objectives, system functionality, equipment configuration, software inventory, etc.

The program manual contains the detailed program specification of all programs used within the application system. The program specification is prepared by the analyst and used by the programmer in the implementation phase. It also serves as an useful reference for future maintenance activities.

The Data Manual documents all data captured, processed or produced by the system. The various forms of data described in the manual include :

  • Source Document involved in the system for data input purpose

  • Data kept in files or databases of the system for future processing

  • Screens/Reports or documents which are output on printer, external media or video display terminal

The Application Operation Manual provides relevant information to the computer operation staff of the system implemented. The manual documents in detail the instructions of all the work to be performed by the computer operation staff in running the application system.

The Application User Manual provides relevant information to the user department of the system implemented. The manual documents an overview of the system and provides detailed user instructions and procedures for all functionality provided by the system.

The Computer Operating Procedures Manual provides information and operating instructions (e.g. switching on/off of hardware equipment, taking system dumps, etc.) related to the operating of the computer system. The intended users are the operating staff of the computer operation department.

PDF file format Click here to download PDF file of Documentation Standards for Implementation Phase Document (1.47MB) Click Here


( To view and print the PDF document, you need to use an Adobe Acrobat Reader. Please click here to download if necessary. Get Acrobat Reader )



  Toptop
  2003 | Important notices | Privacy Policy Last review date : 31 August 2008