嵌入式文档规范·实战

01

文档规范总览 生命周期

为什么嵌入式项目需要文档规范？需求·设计·测试·用户手册分类

02

Markdown基础与扩展 Mermaid

语法速成 · 流程图/时序图 · PlantUML 在文档中的应用

03

需求文档规范 BRD/PRD

需求模板 · MoSCoW优先级 · 可追溯性矩阵

04

系统架构设计文档 C4模型

架构图绘制 · 模块接口IDD · 系统约束与假设

05

硬件设计文档 原理图/BOM

原理图说明 · BOM清单规范 · PCB约束 · 硬件测试用例

06

软件设计文档 HAL/OSAL

软件分层 · 状态机 · API文档自动生成 (Doxygen)

07

固件设计文档 启动/中断

启动流程 · 中断向量表 · 内存布局 · 升级策略

08

通信协议文档 帧格式

协议帧定义 · 时序图 · 错误码 · 版本管理

09

测试文档规范 等价类

测试计划 · 用例编写 · 测试报告 · 缺陷管理

10

用户手册规范 快速入门

手册结构 · 截图标注 · 多语言支持策略

11

版本管理文档 Conventional Commits

Git提交规范 · CHANGELOG · Release Notes模板

12

代码注释规范 Doxygen

注释风格 · 密度质量 · TODO/FIXME标记规范

13

接口文档规范 OpenAPI

RESTful API · 硬件接口GPIO/I2C/SPI · 回调函数

14

安全文档规范 STRIDE

安全需求分析 · 威胁建模 · 安全测试 · 漏洞披露

15

可靠性文档规范 FMEA

MTBF/MTTR · 失效模式分析 · 冗余设计说明

16

可维护性文档 技术债务

重构记录 · 技术债务跟踪 · 模块依赖 · 构建脚本

17

部署与运维文档 拓扑图

部署拓扑 · 环境配置 · 监控指标 · 应急预案

18

合规性文档 CE/FCC

认证清单 · RoHS/REACH · 开源许可证合规

19

项目计划文档 甘特图

甘特图规范 · 里程碑 · 资源分配 · 风险管理

20

会议纪要规范 5W1H

纪要模板 · 行动项跟踪 · 决策记录规范

21

设计评审文档 检查清单

评审检查单 · 意见记录 · 结论与改进措施

22

变更管理文档 CR模板

变更请求 · 影响分析 · 审批流程文档

23

配置管理文档 基线

基线定义 · 配置项标识 · 审计报告模板

24

质量保证文档 代码审查

质量计划 · 审查清单 · 静态分析 · 单元测试覆盖率

25

培训文档规范 FAQ

培训计划 · 操作视频脚本 · FAQ · 知识库建设

26

国际化文档 i18n

术语表 · 翻译记忆库 · 本地化测试 · 文化适配

27

文档自动化工具 Sphinx

Read the Docs · GitBook · 文档CI/CD (GitHub Actions)

28

文档质量度量 可读性

完整性检查 · Flesch-Kincaid · 更新频率指标

29

团队协作规范 Review

命名规则 · 目录结构 · 权限管理 · Review流程

30

综合实战 完整体系

从零搭建嵌入式项目文档体系 · 模板仓库结构