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

模块设计规范

文章目录

1.需求

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

2.概念与逻辑图

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

3.主要的数据结构图

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

4.算法

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

5.接口定义

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

相关推荐
熊猫钓鱼>_>1 天前
基于MCP的桥梁设计规范智能解析与校审系统构建实践
前端·easyui·设计规范
小Mie不吃饭2 天前
【23种设计模式】分类结构有哪些?
java·设计模式·设计规范
数智研发说11 天前
AI技术下研发体系重构
人工智能·科技·设计模式·重构·交互·设计规范
猎板阿权11 天前
厚铜PCB如何兼顾质量与成本?供应商设计规范执行的黄金平衡点
设计规范
AI让世界更懂你17 天前
【ACL系列论文写作指北08-图表设计规范】-让数据与结构一目了然
人工智能·设计规范
2501_9095318324 天前
网页设计规范:从布局到交互的全方位指南
设计规范
江城月下1 个月前
SOLID原则详解:提升软件设计质量的关键
java·spring·mybatis·软件工程·设计原则·设计规范
冷雨夜中漫步1 个月前
设计模式(8)——SOLID原则之依赖倒置原则
设计模式·依赖倒置原则·设计规范
AugustShuai1 个月前
API-标准controller接口
开发语言·json·设计规范·post·标准接口
电子科技圈1 个月前
IAR推动嵌入式开发:云就绪、可扩展的CI/CD和可持续自动化
嵌入式硬件·设计模式·自动化·软件工程·软件构建·设计规范