Summary of IDC billing system documentation

In the process of software development, the preparation, improvement and retention of documents directly affect the next development of software, as well as the quality of software and subsequent software maintenance work. The software industry is a very mobile industry. For a project, if a person leaves, he or she may not only take the project, but also the development prospects of the project. Especially when this person is in the important position, but there is no document left during the development of this project, once this person leaves, this project may not be properly developed. Document retention also plays an important role in software maintenance.

 

Although the document is very important, it is very boring for beginners. I worked hard for a week to write the IDC charging system documents, from October 1st to October 1st. When I see the template, I only know Chinese characters, but I don't know what it means or how to fill in the content. But it's okay that everything is difficult at the beginning. Once the document is written, the speed is quite fast! After writing the document, I also summarized it a little. The following is a little demonstration.

 

• Feasibility Study Report:

Before deciding on software development, the feasibility study report tries to analyze whether the software is suitable for development from various aspects, and compares the proposed system with the existing one, the final decision is whether the software needs to be developed, and whether the software can bring benefits to users. I mainly know the following aspects:

(1) Recommended System: function, performance, input, output, processing process, data process, development environment, operating environment, hardware environment, project, device, software, user, agency impact, funding, social factors, legal factors, use factors, technical feasibility, and other schemes.

(2) Existing Systems: functions, performance, input, output, processing process, and Data Process

 

• Project development plan:

For the project development plan, the most important thing is to reasonably arrange the division of tasks in each stage and develop risk analysis. The tasks are decomposed and divided by personnel.

This article mainly covers interface personnel, progress, budget, and key issues.

 

 

• Software Requirement Specification:

The Software Requirement Specification mainly aims to clarify the requirements, help designers better design products that meet the user's needs, and make clearer regulations on the software. For example: software functions, performance (precision, time characteristics, flexibility,), input and output, data management capabilities, fault handling capabilities, runtime environment requirements.

 

• Outline Design:

The outline design aims to clarify a general design direction for software development. It mainly includes:

1. Overall Design:

Requirements, runtime environment, basic configuration concepts and processing processes, structures, relationships between functional requirements and programs, manual processing processes,

1. Interface Design:

User Interface, external interface, internal interface

1. Operation design:

Run combination module, Run Control, Run Time

1. System Data Structure Design:

Key Points of logical structure design, key points of physical structure design, relationship between data structure and program

1. System error handling design:

Error information, remedy information, system maintenance Design

 

• Detailed Design:

The details are slightly more detailed than the outline design. In fact, some of the content is not the same as the outline design. However, for small-sized software, the detailed design can be directly integrated into the summary design.

 

• Database Design:

The Database Design Instruction is mainly used by the developer to create databases and operate databases. We can easily see the relationship between database tables and reduce redundancy to improve system efficiency. Its main contents include:

1. External design: identifier and status, use its program, conventions, special guidance, support software.

1. Structural Design: conceptual structure design, logical structure design, and physical structure design.
2. Application Design: Data Dictionary design and security and confidentiality design.