How to write a program maintenance manual
I believe that friends who read posts have such a difficult time, it is to write a program maintenance manual after the program is developed. Every time I always race my brain, but I feel that the maintenance manual is not very good. It is often important for a good program maintenance manual for future use and maintenance. Because we can't ask users or later people who look at this program to study this procedure, they must pass the program's maintenance manual, so that the subsequent person can quickly grasp the generals of the program. I now give a relatively general procedure maintenance manual writing format. I hope to bring you convenience. Document Number: Version: Password class: Document Name: XXXX Program Maintenance Manual Project Number: Project Title: Development Department: Project Leader: written proof date date date approved by the review date Program Maintenance Manual 1 Introduction 1.1 Writing Objective [Explain the purpose of writing maintenance manuals, " Point out the reader object (program maintenance personnel, R & D personnel). 1.2 Development Units [Description Project's proposal, project commission unit, development unit, and use place. ] 1.3 Definition [List the original text of the definitions and abbreviations of the professional terms used in this article. ] 1.4 References [can include: a. User Operation Manual; b. Documents related to this item. List the author, title, number, publishing date, publishing unit, or data source and confidentiality level. ] 2 System Description 2.1 System Uses [Description The function, input, and output of the system. ] 2.2 Security Secure [Description System Security Confidential Considering. ] 2.3 Overall Description [Description System's overall function, a comprehensive introduction to subsystems and jobs, and use chart to give internal relationships of the main part of the system. ] 2.4 Program Description [Description Each program in the system, details and features of the division program. ] 2.4.1 Program 1 Description 2.4.1.1 Function [Description Program function. ] 2.4.1.2 Method [Description Implementation Method. ] 2.4.1.3 Enter [Input, Media, Run Data Record, "Input Data" used in the start of the input data, and the entrance requirements related to program initialization. ] 2.4.1.4 Processing [Processing Characteristics and Purpose, such as: a. Logic flow of the running of the program; b. Program main transfer conditions; c. Constraint conditions for the program; d. At the end of the program Export requirements; e. Communication and coupling with the next program; F. The output data type and storage unit generated and stored by the program. g. The storage amount, type, and storage locations used by the program run. ] 2.4.1.5 Output [Output of the program. ] 2.4.1.6 Interface [The program and other part of the present system. ] 2.4.1.7 Table [Description of various tables, details and characteristics of items. The description of each table includes at least: a. Table identifier; b. Use the purpose; c. Use other programs for this table; d. Logic division, such as block or department, do not include an entry; E. Basic Structure; f. Design schedule, including the control information of the table. Idential structural details, unique properties in use and identity, location, use, type, and encoding representation of each item. ] 2.4.1.8 Unique operating nature [Description Operation Nature not mentioned in the user's operating manual. ] 2.4.2 Description of Procedure 2 [That is the same as the programs 1. The other programs in the future will be the same.
