- The original author of this article: Brother Gu’s younger brother
- Author blog address: http://blog.csdn.net/lfdfhl
- Reference materials for this article: "Software Documentation Writing Tutorial" by Electronic Industry Press, edited by Ma Ping and Huang Dongmei
basic requirements
We can grasp the basic requirements of outline design from the following four aspects.
the macro
The outline design book is not a detailed design book. It grasps the overall direction of the system and plays an outline role. Don't get caught up in the specific implementation details in the general design stage, don't blindly pursue details and lose focus.
comprehensive
The outline design book includes all aspects of software operation. Only in the early stage of the project, all possible problems, countermeasures, etc. should be considered as early as possible to avoid emergencies and unnecessary interruption of the software development process. . Do your best to keep everything under control.
clear logic
Software engineering is science and engineering. It does not need gorgeous decoration and unconstrained imagination. What it needs is scientific and reasonable design and clear and rigorous description. Clear logic is a major requirement for scientific and technological literature, and it is also a requirement for outline design documents. How the software system is structured, how the system is divided, and the complex and cumbersome interrelationships between subsystems, only with clear logic can readers grasp the content of the outline design book more quickly and accurately.
rigorous
Different from the requirements specification, its readers are no longer laymen who know little about the computer field, but software designers who will follow up with detailed design. Therefore, the outline design book needs to be rigorous and professional in text, and use outline design tools such as UML to help the system model and analyze the system, so that the results of the outline design stage can be easily understood by practitioners in the detailed design stage.