Source: cnblogs.com.
During software project development, thirteen document types should be written as the development work requires. Documentation must be targeted, precise, clear, complete, flexible and traceable.
1. Feasibility study report: explains whether the project is feasible technically, economically and socially, reviews the possible implementation options for reaching the development goal reasonably, and justifies the chosen one.
2. Project development plan: sets a concrete plan for implementing the project, covering who is responsible for each part, the schedule, the budget, and the hardware and software resources needed.
3. Software requirements specification: describes in detail the functions, performance, user interface and operating environment of the software. It is written once the client and the developers have reached a common understanding and agreement on the requirements, and it is the basis for the development work. It should state the requirements for data logic and data collection, preparing for generating and maintaining the system’s data files.
4. Preliminary design specification: the output of the preliminary design stage, covering function allocation, module division, overall program structure, input and output, interface design, run design, data structure design and error handling, providing the basis for detailed design.
5. Detailed design specification: focuses on how each module is implemented, including algorithms and logic flows.
6. User operation manual: describes the software’s functions, performance and user interface in detail so users know specifically how to use it, and gives operators the knowledge of its various operating conditions, especially the details of operating procedures.
7. Test plan: to run integration and acceptance testing well, an implementation plan is needed covering the test content, schedule, conditions, personnel, principles for selecting test cases and allowed deviation ranges for results.
8. Test analysis report: after testing, a report on how the test plan was executed, an analysis of the results and the testers’ conclusions.
9. Monthly development progress report: the project progress report the software team submits to management monthly, comparing planned with actual progress, covering stage results, problems encountered and solutions, and plans for the next month.
10. Project development summary report: after development, compare against the implementation plan, summarise actual progress, results, resource use, cost and manpower, and evaluate the development work, distilling lessons learned.
11. Software maintenance manual: mainly the system description, program module description, operating environment, supporting software description and maintenance procedures, to facilitate maintenance.
12. Software problem report: records each software problem’s registration details such as date, finder, status and the module involved, preparing documentation for modification.
13. Software modification report: after the product goes live, when problems requiring correction or change are found, describe the problems, the thinking behind the modification and its impact in detail, and submit for approval.
Want to talk through what you just read?
We work end to end, from product design to launch. Tell us about your scenario and we can start there.
Shenzhen XZS Technology Co., Ltd. · Tel 0755-82494862 · 13760424861