Reprinted from Standardization Information Network April 21, 2003
Software Document is also known as files, usually refers to some recorded data and data media, which have fixed forms and can be read by people and computers. It works with the computer program constitutes a computer software that can complete a specific function (someone is also part of the source program as part of the document). We know that hardware products and product information are visible throughout the production process, software production is very different, and the document is software products. Software with no documents, do not do it as software, can't talk about software products. Software documentation has a high status and quite workload in software development. High efficiency, high-quality development, distribution, management and targeted documents have important significance for transfer, change, correction, expansion, and use documents, have important significance for the benefits of full playback of software products. However, in actual work, there are many issues in the preparation and use, and they need to solve it. Software developers are more common in the phenomenon that is not interested in the compilation document. From the user, they often complain: the price of the document is too high, the document is not complete, the document is written is not good, the document is old or the document is too much, difficult to use, etc. How should I ask it, what should I write, explain what issues, what role? Here, a brief introduction will be given. Figure document bridge action documentation in software developers, software management, maintenance personnel, users, and various bridges between users, and computer can be seen from the figure. Software developers are obviously based on the basis of documentation as the preference and post-stage work of the work results in each stage. This role is obvious. During software development, software developers need to develop some work plan or work reports, these plans and reports are provided to managers and have necessary support. Managers can understand software development project arrangements, progress, resource usage, and results through these documents. Software developers need to provide detailed information for users to understand software usage, operation, and maintenance, we call this as a user documentation. The above three documents constitute the main part of the software document. We are listed in Figure 6 in Figure 6. Among them, thirteen documents are listed here: • Feasibility study report: Describe the implementation of the software development project, economic and social factors, and reviews to reasonably achieve development goals A variety of possible schemes, description and demonstrate the reasons for the selected implementation. · Project Development Plan: Develop specific plans for software project implementations, including the responsible persons of various parts, development progress, budget for development, and hardware and software resources required. The project development plan should be provided to the management department and is based on the reference for the development phase. · Software demand manual: also known as software specifications, which make detailed descriptions of the function, performance, user interface, and operating environment of the developed software. It is an agreement reached on the basis of software requirements and the development of software requirements, and is also the basis for implementing development work. · Data requirements specification: This manual should give data logic descriptions and data collection requirements, and prepare for generating and maintaining system data volumes. · Summary Description: This manual is the result of the summary design phase. It should illustrate the functional allocation, module division, overall structure, input and output, and interface design, operation design, data structure design, and error handling design. Laying the foundation. · Detailed Design Manual: Heavy descriptions of how each module is implemented, including implementation algorithms, logic flows, and more. · User Manual: This manual describes the software's function, performance, and user interface, which uses the software. Figure three documentation • Operating Manual: This manual provides the operator to provide the specific details of the various operations of the software, especially the specific details of the operation method. · Test Plan: To do a good job in assembly testing and confirmation test, you need to organize test development implementation plan.
