Guidelines for computer software product development documentation

2Scope / Description

This guide is a guidance document. This guideline suggests that, generally speaking, fourteen kinds of files should be produced during the development of a piece of computer software. The fourteen kinds of documents are: Feasibility study report; Project development plan; Software requirements specification; Data requirements specification; Summary design specification; Detailed design specification; Database design specification; User manual; Operation manual; Module development file; Test plan; Test Analysis report; monthly development progress report; project development summary report. This guideline will give guidelines for the preparation of these fourteen kinds of documents suggested in the development process, and at the same time, this guideline is also a test criterion for the quality of these fourteen kinds of documents. However, this guide does not address the question of how to fill out job forms during software development. Generally speaking, a piece of software is always an integral part of a computer system (including hardware, firmware, and software). In view of the diversity of computer systems, this guide generally does not involve the documentation issues in the entire system development, this guide is only a documentation guide in the software development process.