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

模块设计规范

文章目录

1.需求

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

2.概念与逻辑图

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

3.主要的数据结构图

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

4.算法

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

5.接口定义

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

相关推荐
帅次5 天前
系统分析师:系统规划与分析的系统规划概述、项目的提出和选择、系统分析概述以及问题分析
软件工程·团队开发·软件构建·需求分析·敏捷流程·设计规范·规格说明书
brave and determined6 天前
可编程逻辑器件学习(day34):半导体编年史:从法拉第的意外发现到塑造现代文明的硅基浪潮
人工智能·深度学习·fpga开发·verilog·fpga·设计规范·嵌入式设计
Wpa.wk7 天前
编写测试用例过程,测试用例编写模版示例
测试用例·设计规范·测试用例设计过程
brave and determined9 天前
可编程逻辑器件学习(day29):Verilog HDL可综合代码设计规范与实践指南
深度学习·fpga开发·verilog·fpga·设计规范·硬件编程·嵌入式设计
奋进的电子工程师13 天前
如何实现开源组件的安全与合规治理?
安全·开源·代码规范·设计规范·代码复审
施嘉伟14 天前
中间件设计规范及安装手册
中间件·设计规范
Wild_Pointer.15 天前
设计模式实战精讲:全景目录
设计模式·设计规范
秦明月1324 天前
EPLAN电气设计:快捷键版本差异解析
经验分享·学习·学习方法·设计规范
=>>漫反射=>>1 个月前
【Spring Boot Starter 设计思考:分离模式是否适用于所有场景】
java·spring boot·后端·设计规范·自动装配
bmcyzs1 个月前
【展厅多媒体】展厅小知识:VR体感游戏推动展厅数字化转型
经验分享·科技·游戏·人机交互·软件构建·vr·设计规范