Click on "Uncle Wheat" above and select "Top/Star Public Account"
Welfare dry goods, delivered as soon as possible
Hello everyone, my name is Wheat. For our embedded software, we often write detailed design documents when designing solutions. For example, I have been writing documents for two days this week.
I think a detailed design document is enough to explain the content of the design clearly. You can use flowcharts, mind maps, and block diagrams to illustrate, with a little text. When necessary, you can define some interfaces for external services, or note the interfaces that need to be provided by external modules.
1 Introduction
1.1 Purpose of writing
On the basis of the outline design, this document further refines the system structure, shows the icons of the software structure, physical design, data structure design, and algorithm design, and introduces in detail how each module of the system is implemented, including the related Algorithms, logic flows, etc.
Intended Reader: Programmers
1.2 Background
a. The name of the software system to be developed: computer room charging system
b. The task proposer of the project: Boss Zhang
c. Project developer: Mr. Qi
d. Users of the project: all users of Zhisheng Network
e. Computing station (center) running the software: all hardware devices of Zhisheng Network
1.3 Definitions
System structure: a macro description of the overall layout of the system
Algorithm: The logical expression for the calculation of the internal process of the program.
1.4 References
List relevant references such as:
a. Detailed Design Instructions (G8567-88)
b. "Overview of Software Engineering" edited by Li Cunzhu, published by the Department of Computer Science, Nanjing University, August 2001
2 The structure of the program system
3 General User Design Instructions
3.1 Program Description
This program refers to checking the student's on-off status and student information. It does not involve management functions, but only enters the student's information into the database, and obtains new data information after system processing.
3.2 Function
3.3 Performance
3.3.1 Accuracy
Input precision of the software: only the integer part is preserved
The output precision of the software: only the integer part is retained during the transmission process: only the integer part is retained
3.3.2 Flexibility
A. Changes in the operating environment: The software is suitable for popular operating systems.
b. Variation in Accuracy and Effective Time Limit: Varies by situation.
c. Planned changes and improvements: Software updates and upgrades are made at any time according to user needs.
3.3.3 Requirements for time characteristics.
Corresponding time: within 0.5s
Update processing time: within 0.5s
Data replacement and transmission time: within 1s
3.4 Input items
3.5 Output terms
3.6 Algorithms
Time difference = time to get off the plane - time to get on the plane
The amount is based on the basic data settings and the time difference to determine the calculation method of the amount
3.7 Process logic
3.8 Interface
3.9 Storage allocation
3.10 Annotation Design
Describe the notes to be arranged in this procedure, such as:
a. Comments in the header of the module indicate when the module started writing, who wrote it and its basic functions
b. In the variable declaration stage, roughly explain the type and purpose of the variable
c. Annotate the function of the program code at the decision, loop, or sequence branch point
3.11 Restrictions
You must ensure that the program connects to the server normally
3.12 Test Plan
Test case: select representative data and avoid using exhaustive method
Test method: use white box testing method, statement coverage, decision coverage, condition coverage and other operations.
3.13 Unresolved issues
No
4 Operator Design Instructions
4.1 Program Description
This program refers to checking the student's getting on and off the machine and student information, including registration, recharging, modifying information, returning the card, and querying the operator's work record. Regular users do not have this permission.
4.2 Function
4.3 Performance
4.3.1 Accuracy
Input precision of the software: only the integer part is preserved
The output precision of the software: only the integer part is preserved
Precision during transmission: only the integer part is preserved
4.3.2 Flexibility
A. Changes in the operating environment: The software is suitable for popular operating systems.
b. Variation in Accuracy and Effective Time Limit: Varies by situation.
c. Planned changes and improvements: Software updates and upgrades are made at any time according to user needs.
4.3.3 Requirements for time characteristics.
Corresponding time: within 0.5s
Update processing time: within 0.5s
Data replacement and transmission time: within 1s
4.4 Input items
4.5 Output terms
4.6 Algorithms
Total Amount = Remaining Amount + Recharge Amount
Remaining Amount = Total Amount - Consumption Amount
Refund amount = remaining amount - consumption amount
4.7 Process logic
4.8 Interface
4.9 Storage Allocation
4.10 Annotation Design
Describe the notes to be arranged in this procedure, such as:
d. Comments in the header of the module indicate when the module started writing, who wrote it and its basic functions
e. In the variable declaration stage, roughly explain the type and purpose of the variable
f. Annotate the function of the program code at the decision, loop, or sequence branch point
4.11 Restrictions
You must ensure that the program connects to the server normally
4.12 Test Plan
Mainly in the registration module, pay attention to selecting different data to ensure that the input data is legal and within the specified scope. For the recharge, card return and information maintenance modules, take an example test and observe whether the test results conform to the logic rules.
4.13 Unresolved issues
No
5 Admin Design Instructions
5.1 Program Description
The administrator module is mainly for the management of the entire system, including the viewing and management of operators, the addition and deletion of users, the setting of basic system data and the checkout work.
5.2 Function
5.3 Performance
5.3.1 Accuracy
Input precision of the software: only the integer part is preserved
The output precision of the software: only the integer part is preserved
Precision during transmission: only the integer part is preserved
5.3.2 Flexibility
A. Changes in the operating environment: The software is suitable for popular operating systems.
b. Variation in Accuracy and Effective Time Limit: Varies by situation.
c. Planned changes and improvements: Software updates and upgrades are made at any time according to user needs.
5.3.3 Requirements for time characteristics.
Corresponding time: within 0.5s
Update processing time: within 0.5s
Data replacement and transmission time: within 1s
5.4 Input items
5.5 Output terms
5.6 Algorithms
Total Amount = Remaining Amount + Recharge Amount
Remaining Amount = Total Amount - Consumption Amount
Refund amount = remaining amount - consumption amount
5.7 Process logic
5.8 Interface
5.9 Storage Allocation
5.10 Annotation Design
Describe the notes to be arranged in this procedure, such as:
a. Comments in the header of the module indicate when the module started writing, who wrote it and its basic functions
b. In the variable declaration stage, roughly explain the type and purpose of the variable
c. Annotate the function of the program code at the decision, loop, or sequence branch point
5.11 Restrictions
You must ensure that the program connects to the server normally
5.12 Test Plan
A. Mainly in the checkout module, pay attention to selecting different time periods to observe whether the checkout conforms to the system logic algorithm
b. For adding and deleting user modules, test for example and observe whether the test results conform to the logic rules
c. Finally, there are daily bills and weekly bills to check whether the report is correct, and whether it can be previewed and printed correctly.
5.13 Unresolved issues
No
Thanks for reading, hope it helps!
If you find the article helpful, please help to like, favorite, and forward, thank you!
Original address: https://blog.csdn.net/qizhi666/article/details/84241088?depth_1-
Transferred from the public number: embedded hodgepodge
Copyright statement: This article comes from the Internet, and the copyright belongs to the original author. Copyright issues, please contact to delete.
—— The End ——
Recommended in the past
Expert experience sharing, common reasons for bugs in embedded development
Understand the law of conservation of angular momentum in one minute
How to DIY a retro picture tube clock?
Have you mastered the embedded basic knowledge points that novices often overlook?
An interesting project, OLED realizes "naked eye 3D"
Click on the card above to follow me
Everything you ordered looks good , I take it seriously as I like it