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

模块设计规范

文章目录

1.需求

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

2.概念与逻辑图

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

3.主要的数据结构图

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

4.算法

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

5.接口定义

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

相关推荐
帅次15 天前
系统分析师-计算机系统-计算机系统概述&存储系统
系统架构·硬件架构·软件构建·个人开发·代码规范·设计规范
小马哥编程22 天前
【iSAQB软件架构】架构决策记录-ADR
数据库·架构·系统架构·设计规范
笑衬人心。24 天前
项目中数据库表设计规范与实践(含案例)
服务器·数据库·设计规范
劳埃德福杰1 个月前
【系统规划与管理师第二版】1.3 新一代信息技术及发展
系统架构·软件工程·设计规范
nbsaas-boot1 个月前
Vue 项目中的组件职责划分评审与组件设计规范制定
前端·vue.js·设计规范
智慧城市20301 个月前
96页PPT华为销售战略规划市场洞察品牌策略
动态规划·设计规范
猎板PCB厚铜专家大族2 个月前
高频 PCB 技术发展趋势与应用解析
人工智能·算法·设计规范
先做个垃圾出来………2 个月前
RESTful设计规范(状态码、幂等性)
后端·restful·设计规范
AI设计小站2 个月前
AI 赋能名片设计:告别模板化,创造独特视觉风格
大数据·人工智能·设计规范