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

模块设计规范

文章目录

1.需求

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

2.概念与逻辑图

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

3.主要的数据结构图

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

4.算法

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

5.接口定义

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

相关推荐
七夜zippoe2 天前
API设计规范:RESTful API设计与OpenAPI(Swagger)完整指南
后端·restful·设计规范
yinghuoAI20263 天前
电商视觉进入“无人区”:萤火AI如何用三把“手术刀”重构设计 workflow
设计模式·新媒体运营·产品运营·流量运营·用户运营·内容运营·设计规范
电子科技圈9 天前
SmartDV展示汽车IP解决方案以赋能智驾创芯并加速规模化普及
嵌入式硬件·设计模式·硬件架构·软件工程·软件构建·设计规范
xiangw@GZ13 天前
CapSense底层逻辑:硬件设计规范
单片机·嵌入式硬件·设计规范
stevenzqzq16 天前
MVI架构3--实战示例:我的收藏页面
设计规范·compose·mvi架构
ChoSeitaku17 天前
Git实战|协作开发|分支设计规范|Git实践
git·设计规范
stevenzqzq19 天前
Compose 调用层参数设计规范(基于默认值复用原则)
设计规范·compose
stevenzqzq19 天前
Compose 三层结构设计规范1(基于Slot API)
设计规范·compose
bug攻城狮20 天前
SpringBoot 脚手架搭建指南:从零构建企业级开发框架
java·spring boot·后端·架构·系统架构·设计规范
Watermelo61721 天前
【前端实战】构建 Vue 全局错误处理体系,实现业务与错误的清晰解耦
前端·javascript·vue.js·信息可视化·性能优化·前端框架·设计规范