[工程经验] 模块设计规范

模块设计规范

文章目录

1.需求

根据需求文档,摘录模块的对应部分,细化到可指导开发的程度,并根据实现的需要进行拓展,落地为一份设计文档。

2.概念与逻辑图

定义概念与概念之间的关系,明确模块的边界。定义子模块或子过程的功能, 如函数调用、计算过程等。通过逻辑图更详细地展示程序的运行逻辑。

3.主要的数据结构图

列出内部所需要使用的内存表结构、对象、外部配置数据。在本项目中,希望大家列出所有需要使用的对象和配置,方便 ResourceManager 进行统计和管理。

4.算法

若有较为复杂的计算流程,可单独列出算法流程图。

5.接口定义

规范模块的输入输出格式,与上下游模块的开发者共同协商确定,并落地为接口定义文档

相关推荐
m0_6515939112 小时前
深入理解软件设计中的协议与规范:从理论到Java实践
java·软件工程·代码规范·设计规范
=>>漫反射=>>3 天前
配置的前世今生:从逻辑中抽离,又与逻辑有限融合
java·设计规范
码界奇点7 天前
Spring Web MVC构建现代Java Web应用的基石
java·前端·spring·设计规范
我真的是大笨蛋13 天前
开闭原则详解(OCP)
java·设计模式·性能优化·开闭原则·设计规范
我真的是大笨蛋15 天前
依赖倒置原则(DIP)
java·设计模式·性能优化·依赖倒置原则·设计规范
bmcyzs17 天前
【展厅多媒体】解析VR虚拟驾驶实现多场景自由切换
经验分享·科技·信息可视化·软件构建·vr·设计规范
龙茶清欢20 天前
1、User-Service 服务设计规范文档
java·spring boot·spring cloud·设计规范
龙茶清欢20 天前
4、urbane-commerce 认证请求 DTO 设计规范
java·spring boot·spring cloud·设计规范
Tolines22 天前
PCIe外接卡标准尺寸
嵌入式硬件·硬件工程·设计规范
bmcyzs22 天前
【展厅多媒体】互动虚拟翻书技术应用全解析
经验分享·科技·软件构建·设计规范