Documentation standardization for software project development
During the project development, thirteen documents should be prepared as required, documentation requirement requires targeted, accurate, clarity, integrity, flexibility, traceability. ◇ Feasibility Analysis Report: Description The implementation of the software development project is technically, economic and social factors, and commented on various possible implementations of the development goals to choose from, explain the selected The reason for the implementation plan. ◇ Project Development Plan: Develop a specific plan for the software project implementation, including the responsible personnel of each part of the work, the progress of development, the budget of the development fund, the required hardware and software resources. ◇ Software Demand Manual (Software Specifications): Detailed descriptions of the function, performance, user interface and operational environment of the developed software. It is written under the conditions of the user and the developer to obtain a joint understanding of software requirements and reach an agreement. It is also the basis for implementing development work. The specification should give data logic and data acquisition requirements to prepare for generating and maintaining system data files. ◇ Summary Design Manual: This manual is a summary of the actual phase of work. It should illustrate the function allocation, module division, overall structure, input and output, and interface design, operation design, data structure design, and error handling design. Provide the basis. ◇ Detailed Design Specification: Heavy grants how each module is implemented, including implementation algorithms, logic flows, etc. ◇ User Operation Manual: This manual describes the software's function, performance, and user interface. User users provide specific understanding of how to use this software, providing operator providing the software related knowledge, especially the specific operation method detail. ◇ Test Plan: To do a good job in integrated testing and acceptance testing, it is necessary to organize test and formulate implementation plans. The plan should include the content, progress, condition, personnel, test case selection principle, and the range of deviations allowed by the test results. ◇ Test Analysis Report: After the test work is completed, the instructions of the test plan shall be submitted to analyze the test results, and the conclusions of tests should be proposed. ◇ Development Progress Month: The report of the project file staff reported on the project on the basis of the project, and the report should include the comparison of progress plans and actual implementations, stage results, and the problems and solutions. Monthly plan. ◇ Project Development Summary Report: After the completion of software project development, it should be compared with the project implementation plan, summarize the actual implementation, such as progress, results, resource utilization, cost and investment, and in addition, it is necessary to evaluate development work. Summarize experiences and lessons. ◇ Software Maintenance Manual: It mainly includes software system description, program module description, operating environment, support software instructions, instructions for maintenance process, easy to maintain software. ◇ Software problem report: State out the registration of software issues, such as the date, discovery people, status, problem belonging, etc., provide software modification to provide documentation. ◇ Software Modification Report: After the software product is put into operation, it is discovered that there is a need to make a detailed, change, and the impact of the existence, modification, and the impact of the revision, submit approval.
Feasibility analysis report
1 Introduction 1.1 Writing Purpose: To clarify the purpose of writing a feasibility study report, the reader object is proposed. 1.2 Project Background: Should include ● Name of the recommended development software ● Project task submissions, developers, users, and software units ● Projects and other software or other systems. 1.3 Definition: List the definitions of the dedicated terms used in the document and the original text of the abbreviation word. 1.4 References: List the author, title, number, publishing date, publishing unit or source of information, can include ● Project approved planning task book, contract or superior agency approves ● Published information related to the project ● The data referenced in the documentation, the software standard or specification 2 feasibility study 2.1 Requirements: List and explain the basic requirements for the proposed development software, such as ● Function ● Performance ● Input / Output ● Basic data flow And handling processes ● Safety and confidentiality requirements ● Other systems related to software ● Completion date 2.2 Objective: Can include ● Human and equipment cost savings ● Higher processing speed ● Improvement of control accuracy or productivity ● Improvement of management information services ● Decision System improvements ● Increased work efficiency 2.3 Conditions, assumptions and restrictions: ● It is recommended to develop the shortest life of the development software ● Duration of the obvious program selection comparison ● Provincial Source and Limits ● Limitations in legal and policy ● Hardware, Conditions and restrictions on software, operating environment and development environment ● Used information and resources ● It is recommended to develop software to use the latest time 2.5 Feasibility Research Method 2. Decide the main factor of feasibility 3 to analyze the existing system 3.1 Process flow And data flow 3.3 Workload 3.3 cost spending: such as human, equipment, space, supportive service, materials and other expenditures 3.4 personnel: Professional technical category and quantity of the required personnel 3.5 Devices 3.6 Limitations: Description Existing systems exist The problem and why the need to develop new system 4 recommended technical feasibility analysis 4.1 Brief description of the system 4. You can compare the existing system 4.3 Processing Processes and Data Processes 4.4 Adopt Systems Possible Impact ● Device Impact ● The impact on existing software ● Impact on the user ● The impact on the development environment ● Impact on the expenditure of funds 4.5 technical feasibility evaluation: including ● Under restriction conditions, the function is to achieve ● Utilization The existing technique, whether the function is to achieve ● Requirements for the number and quality of the developers, and explain whether it can be met ● During the specified period, the development can complete 5 recommended system Economic Feasibility Analysis 5.1 Expenditure 5.2 Benefits 5.3 Revenue / Investment Sensitivity analysis of 5.4 Investment Recycling Cycle: Refers to some key factors, such as: ● System survival cycle length ● System workload quantity ● Processing speed requirements ● Analyze 6 Social factors for the effects of equipment and software configuration changes on expenditure and efficiency Feasibility Analysis 6.1 Legal Factors: ● Contract responsibility ● Vocation of patents ● Vocabaries 6.2 User use feasibility: If the user unit administrative management ● Working system ● Whether the quality of personnel can meet the requirements of other alternative options, clarify other options, And focusing on the reasons that are not recommended.
8 Conclusions ● Cannotable organization development ● Waiting for several conditions to develop ● Some modifications to the development target ● Can not be done or do not have to be done ● Other
Project development plan
1 Introduction 1.1 Writing Objective: To clarify the purpose of writing a feasibility study report, proposing the reader object 1.2 Project Background: Should include ● Project's commissioned units, the competent department; ● The relationship between the software system and other systems. 1.3 Definition: The original text of the definition and abbreviations of the dedicated terms used in the documentation 1.4 References: can include: ● Project approved planning task book, contract, or superior agency approved ● Documentation, specification, etc. ● List the author, title, number, publishing date, publishing unit, or source of data; 2 Project Overview 2.1 Work Content: Brief Description Project The main task of the project, introduce the function, performance of the developed software; if you do not write Feasibility study reports; it should be introduced in this section; 2.2 Conditions and restrictions: Conditions to complete the conditions necessary, and the conditions that have had already had already created. The work, completion period, and other conditions and restrictions should also be explained if necessary. 2.3 Products 2.3.1 Programs: List the name of the program that should be delivered, the language and storage form used. 2.3.2 Documentation: List the documentation that should be delivered. 2.4 Operating Environment: The hardware environment, software environment should be included. 2.5 Services: Clauses that development units can provide services to users. Such as personnel training, installation, warranty, maintenance and other operational support. 2.6 Acceptance Standard 3 Implementation Plan 3.1 Task Decomposition: The division of tasks and the person in charge of the tasks. 3.2 Progress: Projects completed in phases, with the chart description start time, complete time. 3.3 Budget 3.4 Key Problem: Description may affect the key issues of the project, such as equipment conditions, technical difficulties, or other risk factors, and explain the countermeasures. 4 personnel organizations and division of labor 5 Delivery period 6 topic plan, such as test plan, quality assurance plan, configuration management plan, personnel training program, system installation plan, etc. Software demand manual
1 Introduction 1.1 Writing Purpose: To clarify the purpose of writing the demand manual, indicate the reader object. 1.2 Project Background: Should include ● Project's entrustment unit, happy unit and competent department; ● The relationship between the software system and other systems should be included. 1.3 Definition: List the definitions and abbreviations of the dedicated terms used in the document. 1.4 References: Can include ● Project approved planning task book, contract, or superior agency approval ● Documentation, specification, etc. 2 Task Overview 2.1 Objective 2.2 Operation Environment 2.3 Conditions and Restrictions 3 Data Description 3.1 State Data 3.2 Dynamic Data: Includes input data and output data. 3.3 Database Description: Gave the name and type of use of the database. 3.4 Data Dictionary 3.5 Data Acquisition 4 Functional Demand 4.1 Functional Division 4.2 Function Description 5 Performance Demand 5.1 Data Accuracy 5.2 Time Features: If the response time, update processing time, data conversion and transmission time, run time, etc. 5.3 Adaptability: When operating, operating the environment, interfaces with other software, and development plans, etc., should have adaptability. 6 Operation Demand 6.1 User Interface: Such as screen format, report format, menu format, input and output time, etc. 6.2 Hardware Interface 6.3 Software Interface 6.4 Troubleshooting 7 Other requirements such as availability, security, maintainability, portability, etc.
Summary design manual
1 Introduction 1.1 Write: Clave the purpose of writing a summary design manual, indicating the reader object. 1.2 Project Background: Should include ● Project commission units, development units, and competent authorities ● The software system is related to other systems. 1.3 Definition: Lists the willingness of the definitions and abbreviations of the dedicated terms used in this document. 1.4 References: ● List the author, title, number, publishing date, publishing unit or data source ● Project approved planning task book, contract or superior aircraft; project development plan; demand specifications; test plan (Premier Draft); User Operation Manual ● The standards or specifications used by the documentation are used. 2 Task Overview 2.1 Target 2.2 Demand Overview 2.3 Conditions and Restrictions 3 Overall Design 3.2 Overall Structure and Module External Design 3.3 Function Allocation: Indicates the relationship between the functions and program structure. 4 Interface Design 4.1 External Interface: Includes user interface, software interface and hardware interface. 4.2 Internal Interface: Interface between modules. 5 Data Structure Design 6 Logical Structure Design All Documents Unified Cover Formats are shown in the next page. 7 Physical Structure Design 8 Data Structure and Procedure Relationship 9 Operation Design 9.1 Operation Module Combination 9.2 Running 9.3 Running Time 10 Error Processing Design 10.1 Error Output Information 10.2 Error Processing Countermeasures: Settings, Performance Downgrading, Recovery, and Reproduction . 11 Safety Confidential Design 12 Maintenance Design Instructions for facilities for easy maintenance, such as maintenance modules.
Detailed design manual
1 Introduction 1.1 Writing purposes:
The purpose of the detailed design specification is to indicate the reader object. 1.2 Project Background: Should include the source of the project and the competent department, etc. 1.3 Definition: Lists the willingness of the definitions and abbreviations of the dedicated terms used in this document. 1.4 References: ● List the author, title, number, publishing date, publishing unit or data source ● Project approved planning task book, contract or superior agency; project development plan; demand specifications; profile design Manual; test plan (first draft); User Operation Manual ● The standards or specifications of information, software development cited by documents. 2 Overall Design 2.1 Demand Overview 2.2 Software Structure: As shown in the software system. 3 Program Description 3.1 Give the following instructions by module: ● Function ● Performance ● Enter item ● Output item 3.2 Algorithm: The algorithm selected by the module. 3.3 Program Logic: Detailed Description Module Implementation Algorithm, can adopt: standard flow chart; PDL language; N-S map; judgment table, etc. describe the graph of algorithm. 3.4 Interface ● Storage assignment ● Restrictions 3.5 Test key points: give the main test requirements for the test module.
User Operation Manual
1 Introduction 1.1 Writing: Explain the purpose of writing the manual, indicating the reader object. 1.2 Project Background: Description Project Source, Entrusted Units, Development Units and Supervisors. 1.3 Definition: List the definitions of specialized terms used in the manual and the willingness of the abbreviation. 1.4 References: ● List the author, title, number, publishing date, publishing unit or data source ● Project approved planning task book, contract or superior agency; project development plan; demand specifications; profile design Instructions; Detailed Design Specifications; Test Plan ● Other information from the documentation, software engineering standards or software engineering specifications. 2 Software Overview 2.1 Objective 2.2 Function 2.3 Performance 2.4 Data accuracy: Includes input, output, and processing data accuracy. 2.5 Time Features: Such as response time, processing time, data transfer time, etc. 2.6 Flexibility: In operation, the operating environment needs to be adaptable when certain changes. 3 Operation Environment 3.1 Hardware ● List the hardware minimum configuration required for software system runtime, such as computer model, main memory capacity ● Outer memory, media, record format, device model and quantity ● Input, output device ● Data transmission device and data Model and quantity of the conversion device. 3.2 Support Software ● Operating System Name and Version Number ● Language Compile System or Compilation System Name and Version Number ● Database Management System Name and Version Number ● Other Support Software 4 Instructions 4.1 Installation and Initialization: Give Program Storage Forms, operational commands, feedback information, and their own integration, indicating that the installation completed test instance and software tools needed to install. 4.2 Enter: Give an input data or parameter requirements. ● Data background: Description data source, storage media, frequency, limit, and quality management, etc. ● Data format: such as length, format, label, order, separator, vocabulary, omission, and repetitive, control. ● Enter an example. 4.3 Output: The description of each output data is given. ● Data background: Description Output data, frequency, storage media, quality management, etc. ● Data format: Detailed explanation of the format of each output data, such as the first, main body, and tail specific forms. ● Example 4.4 Error and Recovery: Give an error message and its meaning; the user should take the measures, such as modify, restore, and then start. 4.5 Help Query: How to operate. 5 Operation Description 5.1 Runtime: List each possible operation, explain its operational purpose. 5.2 Running steps: In order to explain the steps of each and run, including: 5.3 Operation Control 5.4 Operation information: Run the purpose, run the purpose, operation requirements, startup method, expected runtime, operation command format and instructions, other matters; 5.5 input / Output file: give information about the establishment or update file, such as the name and number of the file; record the media; the directory of the deposit; the file dominance: Description Determines the guidelines for retained files or discard files, the object of distribution files, overcome the hardware Priority and confidentiality control, etc. 5.6 Start or Recovery Process 6 Unconventional Process Provides an essential information and operational steps of emergency rings, such as error handling operations, switching operations and precautions to backup systems and maintenance personnel. 7 Operation Command List The format, function, and parameter description of all operation commands are listed one by one.
8 Program files (or command files) and data file list list by file name, identifier, and descriptions by file name alphabetical order or by function and module.
9 User Operation Example
Test Plan
1 Introduction 1.1 Writing Purpose: To clarify the purpose of writing test programs and indicate the reader object. 1.2 Project Background: Description Project Source, Entrusted Unit and Administration. 1.3 Definition: List the definitions of specialized terms used in the test plan and the idea of abbreviation. 1.4 References: List the author, title, number, publishing date, publishing unit, or source of authorization, programming task, contract or appraisal; project development plan; demand specification; detailed design; Design manual; user operating manual; other information referenced in this test plan, software development standards or specifications. 2 Task Overview 2.1 Target 2.2 Operation Environment 2.3 Requirements Overview 2.4 Conditions and Restrictions 3 Program 3.1 Test Scheme: Description Test Method and Selecting the Principle of Test Examples. 3.2 Test Project: List the content, name, purpose, and progress of each test in the assembly test and confirmation test. 3.3 Test Preparation 3.4 Testing agencies and Personnel: Testing agency Name, person in charge and responsibilities. 4 Test Item Description 4.1 Say by order 4.1.1 Test Project Name and Test Content 4.1.2 Test Example 4.1.3 Enter: Enter the data and input commands. 4.1.4 Output: expected
Output Data. 4.2 Steps and Operation 4.3 Allow Deviation: The range of allowed deviations between the measured results and the expected results. 4.4 Progress 4.5 Conditions: Give a special requirement for resources, such as equipment, software, personnel, etc. 4.6 Test Information: Describes the information required for item test. 5 Evaluation 5.1 Range: The scope of the test of the tests completed and its limitations. 5.2 Guidelines: Describe the guidelines for comment test results.
Test analysis report
1 Introduction 1.1 Writing: Explain the purpose of writing test analysis reports and indicating the reader object. 1.2 Project Background: Description Project Source, Entrusted Unit and Administration. 1.3 Definition: List the principles of special terms used in the test analysis report and the idea of the abbreviation. 1.4 References: List the author, title, number, publishing date, publishing unit, or source of authorization, programming task, contract or appraisal; project development plan; demand specification; detailed design; Design manual; user operating manual; test plan; other information used by the test analysis report, the use of software engineering standards or engineering specifications. 2 Test Plan Entertainment 2.1 Institutions and Personnel: Give the test organization name, person in charge, and list of test personnel. 2.2 Test Results: Each test item is given in order: the measured results data; the deviation from the expected results data; the test indicated by the test; the test discovered by the test. 3 Software demand test conclusions give the conclusions of each requirement test in order. Including: Confirmed software capabilities; limitations (ie, the need for adequate tests and reasons.
4 Evaluation 4.1 Software Ability: The software capabilities indicated by the test. 4.2 Defects and Restrictions: Describe the software defects and insufficient software disclosed, and may have the impact of software operation. 4.3 Recommendation: It is proposed to compensate for the recommendations of the above defects. 4.4 Test Conclusion: Description Can pass.
Development schedule month
1 Report time and development phase 2 Project progress 2.1 Main activities in this month 2.2 Practical progress and program comparison 3 Timed at different levels at different levels.
4 When the machine is used, press the computer model used.
5 Fund expenditure classification lists this month's fund expenditure project, gives the total expenditure, and compares with the plan.
6 The problem encountered and the countermeasures taken 7 The results of this month were taken down next month's work plan 9 special issues
Project development summary report
1 Introduction 1.1 Writing: Explain the purpose of writing summary reports and indicate the reader object. 1.2 Project Background: Description Project Source, Entrusted Units, Development Units and Administration. 1.3 Definition: List the definitions of the dedicated terms used in the report and the idea of abbreviation words. 1.4 References: List the author, title, number, publishing date, publishing unit, or source of authorization, programming task, contract or appraisal; project development plan; demand specification; detailed design; Design instructions; user operating manual; test plan; test analysis report; other information referenced by this report, the development standards or development specifications. 2 Development Results 2.1 Products: Can include the program name of each part, source line (including the notes), or the target program bytes, and the total number of procedures, storage form; product document name, etc. 2.2 Main Features and Performance 2.3 Timed Time Time: According to the different levels of the personnel. 2.4 When using the machine: Press the computer model used. 2.5 Progress: Give the comparison of plan progress and actual progress. 2.6 Fees 3 Reviews 3.1 Productivity Evaluation: If the average monthly production source, the number of words, etc. 3.2 Technical Program Evaluation 3.3 Product Quality Evaluation 4 Experience and Teaching Software Maintenance Manual
1 Introduction 1.1 Writing: Explain the purpose of writing the manual and specify the reader object. 1.2 Project Background: Description Projects, developers, users, and use places. 1.3 Definition: List the definitions of the dedicated terms used in the report and the idea of abbreviation words. 1.4 References: List the author, title, number, publishing date, publishing unit or data source, and confidentiality level, and confidentiality manual; other documents related to this item. 2 System Description 2.1 System Usage: Describe the functionality, input, and output of the system. 2.2 Security Profit: Describe the considering of system security confidentiality. 2.3 Overall Description: Describe the overall function of the system, a comprehensive introduction to the system, subsystem, and jobs, and give the internal relationship between the main part of the system with a chart. 2.4 Program Description: Describes the details and characteristics of each program in the system. 2.4.1 Description of Program 1 ● Features: Description Program features. ● Method: Description Implementation method. ● Enter: Description Program input, media, run data record, type of input data used in the start of the input data, and stored units related to program initialization. ● Processing: Processing features and purposes, such as the logic flow of the run of the program; the program main transfer conditions; the constraints of the program; the export requirements of the program; communication and connection with the next program (operation, control ); Generated by the program and the output data type and storage unit used by the tea house processing program; the program runs the storage amount, the type, and storage locations. ● Output: The output of the program. ● Interface: This program is with other parts of this system. ● Table: Details and features of various tables, items inside the program. Description of each table includes at least the identifier of the table; using the purpose; other programs for this table; logical division, such as blocks or portions, not including entry; the basic structure of the table; design arrangements, 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. ● Unique operating properties: Describe the operating properties not mentioned in the user's operating manual. 2.4.2 The description of the program 2 is the same as the description of the program 1. The description of the other programs in the future is the same. 3 Operating Environment 3.1 Equipment: Type item by item Description System's device configuration and its characteristics. 3.2 Support Software: List the support software used by the system, package
Huitan names and version numbers. 3.3 Database: Describe the nature and content of each database, including security considerations. 3.3.1 Overall Features: If the identifier is used, the program, static data, dynamic data; database storage media; the program uses the database. 3.3.2 Structure and Detailed Description ● Describe the structure of the database, including the records and items. ● Describe the composition of the record, including the head or control segment, the recording body. ● Describe the fields of each recording structure, including: tag or label, field length, and bits, the allowable value range of this field. ● Expansion: Describe the regulations for recording the additional fields. 4 Maintenance Procedure 4.1 Convention: List all rules and conventions used in the software system design, including: programs, division programs, records, fields, and use rules for labeling museums; chart processing standards, cards The connection order, the abbreviation used in the statement, and the symbol name in the chart; the software technical standard used; standardized data elements and its characteristics. 4.2 Verification Process: After a program segment is modified, the request for verification and procedures (including test programs and data) and program periodically verified. 4.3 Error and Correction Method: List the error status and its corrective method. 4.4 Special Maintenance Process: Description Documentation There are no special maintenance processes mentioned. Such as: Maintaining the input and output section of the software system (such as database), process and verification method; the process and verification method necessary to run the program maintenance system; the process and verification method required for the leap year, century change, etc. . 4.5 Dedicated Maintenance: List the directory of the backup technology and dedicated programs used by the maintenance software system (such as file recovery procedures, programs, etc.), and instructions, including: Maintenance Job input and output requirements; input details The process is established, run and complete the operation steps of the maintenance job on the hard device. 4.6 Program List and Flowchart: Quote or Provide Appendix to give a list of procedures and flowcharts. Software problem report
1 The registration number is specified for the report by the software configuration management department to specify a unique, order number.
2 Registration date software configuration management department registers the date of the report.
3 Question findings discovered the date and time of the problem.
4 Which stage of the activity found in this phase, divided into unit test, assembly test, confirming test, and operating maintenance.
5 Status Dynamic instructions maintained in the software configuration record, the status is represented: "Software Problem Report" is being reviewed to determine what action will be taken; "Software Problem Report" has been processed by the designated person; the modification has been completed, and After testing, it is preparing to handle the main library; the main sequence has been updated, the re-test of the main sequence re-test is not completed; doing retest, problem reproduction; doing retest, the modification of the "Software The problem report is turned off; it will be closed later. 6 The speaker fills in the name, address, telephone number of the "Software Problem Report". 7 What is the problem that is the problem of the program, or the problem of the module, or the database problem, the file problem. It may also be some of their combinations.
The module name that appears in the 8 module / subsystem. If you do not know which module, you can marke the subsystem name, try to give details.
9 Rev. Version Number Problem Module Version.
10 Tape contains an identifier of the tape of the main sequence of the module.
11 Database When discovered a problem, the identifier of the database is used.
12 file number has the number of files.
13 Test case discovers the identifier of the test case used when the error is used.
14 The logo of the computer system used when the hardware discovers the error.
15 Problem Description / Detailed description of the problem of impact problems. If possible, the actual problem is written. It is also necessary to give this problem in the influence of future testing, interface software and documentation. 16 Note Replenishment Information.
Software modification report
1 Registration number is the number specified by the software configuration management department.
2 Registration date software configuration management department registers the date of "Software Modify Report". 3 times is ready for Software Modify Report. 4 The speaker fills in the author of the report.
5 Subsystem names are subject to a subsystem name affected by the modified.
6 Module name modified module name.
7 The number of the Software Problem Report is "Software Modify Report" or partially handled the number of "Software Problem Report". If a "software problem report" problem is only partially processed, then P, such as 1234p after the number. 8 Modifications include program modifications, file updates, database modifications, or combinations thereof.
9 Modify the description of the description of the modification. If it is a file update or database modification, the identifier of the file update notification or database modification request is listed.
10 Approved people's approval people sign, formally approved for modification.
11 Statement Type Program Modifications The statement types involved, including: input / output statement class, calculating statement class, logical control statement class, data processing statement class (such as data transfer, access clause class). 12 Program name modified program, file or database name.
13 Old revised edition current version / revision. 14 New revised version of the revised version / revision logo. 15 Database If you apply for a database modification, the identifier of the database is given.
16 Database Modify Report Database Modify the application number.
17 File If you are required to modify the file, the name of the file is given.
18 File update file update notification number.
19 Modify whether it has been tested to point out which tests have been made to modify, such as units, subsystems, assembly, confirmation, and run testing, etc., and indicate whether the test is successful or not.
20 "Software Problem Report"
The exact description of the problem is 'is' or 'No'. 21 Problem Note Accurately describe the problem to be maintained.
22 Question Sources Indicates where issues come, such as software requirements, design specification, database, source program, etc.
23 Resources Complete the estimate of the required resource, that is, the total number of people and the overhead of computer time.
