Document writing standardization
Source: http://showsky.51.net
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 Objective: To clarify the purpose of writing a feasibility study report, proposing the reader object.
1.2 Project Background: Should include
● The name of the proposed development software
● Mission for projects, developers, users, and software units
● Project relationships with 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, may include
● Project approved planning task book, contract or batch of superior agencies
● Published information related to the project
● The information or specifications used in the documentation
2 premise of 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 processing flow
● Safety and confidentiality requirements
● Other systems related to software
● Completion date
2.2 Target: Can include
● Save the Human and equipment costs
● Improvement of processing speed
● Increased control accuracy or productivity
● Improvement of management information services
● Improvement of decision system
● Improvement of staff work efficiency
2.3 Conditions, assumptions, and restrictions:
● It is recommended to develop the shortest life of software operation.
● Perform time limit for obvious program selection comparison
● Source and limitations
● Limitations in laws and policies
● Conditions and restrictions on hardware, software, operating environment, and development environments
● Information and resources available
● It is recommended to develop software to put into use.
2.4 Feasibility Research Method
2.5 Deciding the main factors for feasibility
3 Analysis of existing systems
3.1 Processing Process and Data Process
3.2 Workload
3.3 cost spending: such as human, equipment, space, supportive service, materials and other expenditures
3.4 Personnel: List the professional technical categories and quantities of the required personnel
3.5 equipment
3.6 Limitations: Description Existing systems existing problems and why need to develop new systems
4 recommended technical feasibility analysis
4.1 Brief Description of the System
4.2 Superiority compared to existing systems
4.3 Processing Process and Data Process
4.4 Adoption of the impact of recommendations
● Impact on equipment
● Impact on existing software
● Impact on users
● Impact on system operation
● Impact on the development environment
● Impact on funding expenditures
4.5 Technical Feasibility Evaluation: including
● Whether the function is achieved under restriction conditions
● Use the existing technology, whether the function is achieved
● Requirements for the number and quality of developers, and explain the meeting
● During the prescribed time limit, the development can be completed
5 proposed system economic feasibility analysis
5.1 spending
5.2 benefits
5.3 Yield / Investment
5.4 Investment Recycling Cycle
5.5 Sensitivity analysis: Refers to some key factors, such as:
● System survival cycle length
● System workload volume
● Processing speed requirements
● Analysis of the impact of equipment and software configuration changes on spending and benefits
6 Social Factor Feasibility Analysis
6.1 Legal Factors:
● Contract responsibility
● Infringement of patents
● Vanning copyright
6.2 Users use feasibility:
● Administrative management of user units
● Working system
● Can people qualify for quality?
7 Other optional options
Capcribed other available options one by one, focusing on the reasons that are not recommended.
8 conclusions
● Can be able to organize development
● Waiting for several conditions to develop
● Some modifications to the development goals need
● Can't do or do not
● Others
Project development plan
1 Introduction
1.1 Writing: Explain the purpose of writing a feasibility study report, propose reader objects
1.2 Project Background: Should include
● Project's commission unit, development unit and competent department;
● The relationship between the software system and other systems.
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 batch of superior agencies
● Information, specification, etc. referenced by the document
● List the author, title, number, date, publishing unit, or source of data;
2 Project Overview
2.1 Work content: Summary of the main tasks of the project, introduce the functionality, performance of the developed software; if you do not write a feasibility study report; then give more detailed introduction in this section;
2.2 Conditions and Restrictions: Conditions to complete the conditions that should have, and the conditions that have already had to create conditions and conditions that need to be 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 programs 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 Issues: 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 programs, quality assurance plans, configuration management plans, personnel training programs, system installation plans, etc.
Software demand manual
1 Introduction
1.1 Writing Objective: To clarify the purpose of writing a demand manual, indicating the reader object.
1.2 Project Background: Should include
● Project's entrustment unit, happy unit and supervisor;
● The relationship between the software system and other systems.
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 batch of superior agencies
● Information, specification, etc. referenced by the document
● List the author, title, number, publishing date, publishing unit or source of information
2 task overview
2.1 goals
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 needs
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 running 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 needs
Such as availability, security, maintenance, 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's commissioned unit, development unit and supervisor
● The relationship between the software system and 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 source of information
● Project approved planning task book, contract, or superior aircraft; project development plan; demand specifications; test plan (first draft); user operating manual
● The materials or specifications used by the documentation are used.
2 task overview
2.1 goals
2.2 Demand Overview
2.3 Conditions and Restrictions
3 overall design
3.2 Overall Structure and Module External Design
3.3 Function assignment: Indicates the relationship between the functions and program structure.
4 interface design
4.1 External Interface: Includes the user interface, the software interface and the hardware interface.
4.2 Internal Interface: Interface between modules.
5 data structural design
6 logical structure design
The unified cover format of all documents is shown in the next page.
7 physical structure design
8 Data structure and program relationship
9 operation design
9.1 Combination of running module
9.2 Operation Control
9.3 Running time
10 error handling design
10.1 error output information
10.2 Error Treatment Countermeasures: If the reserve, performance degradation, recovery, and then start.
11 Safety Confidential Design
12 maintenance design
Note facilities for easy maintenance work, such as maintenance modules, etc.
Detailed design manual
1 Introduction
1.1 Writing Purpose: To clarify the purpose of writing a detailed design manual, indicating 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 source of information
● Project approved planning task book, contract or batch of contract or superior organ; project development plan; demand specifications; profile design instructions; test plan (first draft); user operating 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 A module is given the following instructions:
● Function
● Performance
● Enter items
● Output project
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
● Restriction conditions
3.5 Test Points: Give the main test requirements for the test module.
User Operation Manual
1 Introduction
1.1 Write the purpose: clarify 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 source of information
● Project approved planning task book, contract or batch of contract or superior agency; project development plan; demand specifications; profile design instructions; detailed design manual; test plan
● Other information referenced in the documentation, the use of software engineering standards or software engineering specifications.
2 Software Overview
2.1 goals
2.2 function
2.3 performance
2.4 Data accuracy: Includes input, output, and accuracy of processing data.
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 operating environment
3.1 Hardware
● List the hardware minimum configuration required for software system runtime, such as computer model, main memory capacity
● External memory, media, record format, equipment model and quantity
● Input, output device
● The model and quantity of the data transmission device and the data conversion device.
3.2 Support Software
● Operating system name and version number
● Name and version number of language compilation system or assembly system
● The name and version number of the database management system
● Other necessary support software
4 instructions
4.1 Installation and Initialization: Give the program's storage form, operation command, feedback information, and its integration, indicating that the installation completed test instance and software tools required 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, such as modification, recovery, and then start.
4.5 Help Query: How to operate.
5 Operations
5.1 Runtime: List each possible operation, indicating its operational purpose.
5.2 Running steps: The steps of each and run according to the order should include: 5.3 running control
5.4 Operation information: Operation purposes, running purposes, operational requirements, startup methods, expected runtime, operation command format, and 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 retention; the file domain: Description Determines the guidelines for retained files or discard files, distribute files, The priority and confidentiality control of the hardware.
5.6 Start or recovery process
6 unconventional process
Provide the necessary information and operational steps for emergency unconventional operations, such as error handling operations, switching operations and precautions to backup systems and maintenance personnel.
7 Operation Command List
List the formats, functions, and parameter descriptions of all operation commands in alphabetical order.
8 Program file (or command file) and data file list
List file names, identifiers and instructions one by one by file name alphabetical order or by function and module classification order.
9 User Operation Example
Test Plan
1 Introduction
1.1 Write the purpose: 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 goals
2.2 Operation Environment
2.3 Demand Overview
2.4 Conditions and Restrictions
3 plan
3.1 Test Scheme: Describe the principle of test methods and selection test cases.
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 Test agencies and staff: Test institution name, person in charge, and responsibilities.
4 test item description
4.1 Make a test item in order
4.1.1 Test Project Name and Test Content
4.1.2 Test case
4.1.3 Enter: Enter the data and input commands.
4.1.4 Output: The expected output data.
4.2 Steps and operations
4.3 Allowing 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 Purpose: To clarify the purpose of writing test analysis reports and indicate 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 staff.
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
A conclusion of each requirement test is given 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 stage
2 project progress
2.1 Main activities within this month
2.2 Real progress and plan comparison
3 tools used
Turn at different levels.
4
Press the computer model used separately.
5 fundamental expenditure
Classification lists this month's funds expenditure project, gives the total expenditure, and compares with the plan.
6 Problems encountered and the countermeasures taken
7 results completed this month
8 next month's work plan
9 special issues
Project development summary report
1 Introduction
1.1 Writing Purpose: To clarify 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 number of program names, source line counts (including note lines) or target program byout the number, storage form; product document name, etc.
2.2 Main functions and performance
2.3 Timed hours of use: The timing is performed according to the different levels of the person.
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 evaluation
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 lessons
Software Maintenance Manual
1 Introduction
1.1 Writing Purpose: To clarify the purpose of writing the manual and indicate 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 Uses: Describes the function, 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 the 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 Description of the program 2
The same as 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 Device Configuration and Its Features.
3.2 Support Software: List the support software used by the system, including their name and version number.
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 process
4.1 Convention: List all rules and conventions used in the software system design, including: programs, division programs, records, fields, and use rules for marking helps; processing standards for charts, card connection order , The abbreviation used in the statement and the mark, appears in the symbol name in the chart; the software technical standards used; standardized data elements and their 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 registration number
The software configuration management department specifies a unique, order number for the report.
2 registration date
The software configuration management department registers the date of the report.
3 problem discovery date
Discover the date and time of this problem.
4 activities
In which phase of the discovery problem is divided into unit test, assembly test, confirmation test, and operation maintenance.
5 state
Dynamic instructions maintained in the software configuration record, status indicating: "Software Problem Report" is being reviewed to determine what action will be taken; "Software Problem Report" has been processed by the specified person; modification has been completed, and test Preparing to give the main library; the main sequence has been updated, the retest of the main sequence modification is not completed; doing retest, problem reproduction; doing retest, the modification of the software, "Software problem report "It is closed; it will be closed later. 6 speaker
Fill in the name, address, telephone number of the "Software Problem Report".
7 What is the problem belonging?
Distinguish the problem of the program, or the problem of the module, or the problem of the database, the file problem. It may also be some of their combinations.
8 module / subsystem
The module name that appears. If you do not know which module, you can marke the subsystem name, try to give details.
9 revision
Module version of the problem occurs.
10 tape
The identifier of the tape of the main sequence of the module containing problems.
11 database
The identifier of the database used when the problem is found.
12 file number
There is a wrong file number.
13 test case
The identifier of the test case used is found when the error is found.
14 hardware
The identity of the computer system used is found when the error is found.
15 Problem Description / Influence
Detailed description of the problem of the problem. 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
Replenish the supplementary information.
Software modification report
1 registration number
The number of the report specified by the software configuration management department.
2 registration date
Software configuration management department registers the date of "Software Modify Report".
3 time
Prepare the date of "Software Modify Report".
4 speaker
Fill in the author of the report.
5 subsystem name
Subsystem name affected by modified.
6 module name
Modified module name.
7 "Software Problem Report"
The number of "Software Modify Report" processing or partially processed "Software Problem Report". If a "software problem report" problem is only partially processed, then P, such as 1234p after the number.
8 modified
Includes program modifications, file updates, database modifications, or their combinations.
9 modified description
Detailed description of modifications. If it is a file update or database modification, the identifier of the file update notification or database modification request is listed.
10 approvers
Approved people sign, formally approved for modification.
11 statement type
The statement type involved in the program modification, including: input / output statement class, calculating statement class, logical control statement class, data processing statement class, such as data transfer, access statement class).
12 program name
The name of the modified program, file or database.
13 old revision
Current version / revision.
14 new revision
Modified version / revisions.
15 database
If you apply for a database modification, the identifier of the database is given.
16 Database Modify Report
Database modification application number.
17 file
If you are required to modify the file, the name of the file is given.
18 file update
Document update notification number.
19 Modify if it has been tested
It is pointed out which tests have been made to modifying, such as units, subsystems, assembly, confirmation, and run tests, and indicate whether the test is successful or not.
20 "Software Problem Report" gives an accurate description of the problem
Answer 'is' or 'No'.
21 question comment
Accurately describe the problem to be maintained.
22 problem source
Indicate the problem from where, such as software requirements, design manual, database, source program, etc.
23 resource
Complete the estimate of the required resource, that is, the total number of people and the overhead of computer time.
Author: shows days
