(go) software Overview Design Documentation

Source: Internet
Author: User
Tags documentation error handling
Software Summary Design Manual
China self-Study programming network collection and collation

1. Introduction
1. 1 purpose of writing "to clarify the purpose of writing a summary design specification, indicating the reader object." 】
1. 2 Project Background "should be included. A The project's entrusted units, development units and competent departments. b The relationship between the software system and its F1 system. 】
1. 3 definition "lists the definitions and acronyms of the specialized terms used in this document. 】
1. 4 References "lists the author, title, number, date of publication, publication unit or source of the information, which may be Mao Kua: A. Approval of the project's approved plan of assignment, contract or superior authority; B. Project development Plan, C. Demand specification said ear book; d. Test plan (first draft), E. User manual (first draft), F. The materials referenced in the document, the standards or specifications adopted. 】


2. Task Overview
2. 1 goals
2. 2 Operating Environment
2. 3 Requirements Overview
2. 4 Conditions and limitations


3. Overall Design
3. 1 Processing Flow
3. 2 overall structure and module exterior design
3. 3 Functional Distribution "indicates the relationship between functions and the structure of the program. 】


4. Interface Design
4. 1 external interface "includes user interface, software interface and hardware interface. 】
4. interface between the 2 internal interface "modules. 】


5. Data Structure Design
5. 1 Logical Structure Design
5. 2 Physical Structure Design
5. 3 The relationship between data structure and program


6. Run the design
6. 1 combination of running modules
6. 2 Operation Control
6. 3 Run time


7. Error Handling design
7. 1 Error Output information
7. 2 error handling countermeasures "such as setting up fallback, performance degradation, recovery, and restart. 】


8. Security and confidentiality design


9. Maintenance Design
"Description is for the convenience of maintenance work facilities, such as maintenance modules. 】

Transferred from: http://www.blogjava.net/electricwave/articles/235780.html

Related Article

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.