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

模块设计规范

文章目录

1.需求

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

2.概念与逻辑图

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

3.主要的数据结构图

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

4.算法

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

5.接口定义

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

相关推荐
AugustShuai1 天前
API-标准controller接口
开发语言·json·设计规范·post·标准接口
电子科技圈2 天前
IAR推动嵌入式开发:云就绪、可扩展的CI/CD和可持续自动化
嵌入式硬件·设计模式·自动化·软件工程·软件构建·设计规范
撒呼呼1 个月前
设计模式 - 工厂模式 精准梳理&精准记忆
java·设计模式·简单工厂模式·工厂方法模式·抽象工厂模式·设计规范
啾啾Fun1 个月前
[代码规范]接口设计规范
代码规范·设计规范
qw9492 个月前
MySQL(高级特性篇)11章——数据库的设计规范
设计规范
星糖曙光2 个月前
开发一个音响控制板程序,需要从硬件架构设计、通信协议选择、核心功能实现三个层面进行系统化开发。以下是基于工业级开发流程的实施方案
stm32·课程设计·emacs·ai编程·设计规范
黄焖鸡能干四碗2 个月前
什么是信创?信创国产化改造建设实施方案,信创平台搭建,信创技术方案
安全·web安全·需求分析·信创·设计规范·国产化
香香甜甜的辣椒炒肉2 个月前
UI-设计规范大小总结
ui·设计规范
1024小神3 个月前
macos的图标过大,这是因为有自己的设计规范
设计规范
一只鹿鹿鹿3 个月前
IT程序设计文档,软件需求设计文档,详细设计模板(Word原件)
开发语言·数据库·安全·需求分析·设计规范