本文主要是介绍[工程经验] 模块设计规范,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
模块设计规范
文章目录
- 模块设计规范
- 1.需求
- 2.概念与逻辑图
- 3.主要的数据结构图
- 4.算法
- 5.接口定义
1.需求
根据需求文档,摘录模块的对应部分,细化到可指导开发的程度,并根据实现的需要进行拓展,落地为一份设计文档。
2.概念与逻辑图
定义概念与概念之间的关系,明确模块的边界。定义子模块或子过程的功能, 如函数调用、计算过程等。通过逻辑图更详细地展示程序的运行逻辑。
3.主要的数据结构图
列出内部所需要使用的内存表结构、对象、外部配置数据。在本项目中,希望大家列出所有需要使用的对象和配置,方便 ResourceManager 进行统计和管理。
4.算法
若有较为复杂的计算流程,可单独列出算法流程图。
5.接口定义
规范模块的输入输出格式,与上下游模块的开发者共同协商确定,并落地为接口定义文档
这篇关于[工程经验] 模块设计规范的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!