嵌入式项目文档三件套——规则、清单、待办
📅 2026/7/30 16:09:57
👁️ 阅读次数
📝 编程学习
一句话: 三个文件跟着项目走——CLAUDE.md 存规则(AI 自动读)、调试清单存进度(带 checkbox)、待确认存跨会话待办。代码改了这三个文件要同步更新。
适合谁读:嵌入式项目文档散落各处、换台机器就不知道做到哪的开发者。
三件套
| 文件 | 内容 | 谁读 | 更新时机 |
|---|---|---|---|
| CLAUDE.md | 编码约束、命名规则、流程、禁止项 | AI 每次会话自动加载 | 规则变了或踩了新坑 |
| 上板调试流程.md | 分阶段带 checkbox 的调试清单 | 人 + AI | 每过一阶段打勾 |
| 待确认事项.md | 跨状态的阻塞项(硬件标定、同事配合、发货检查) | 人 + AI | 有新待确认立即加 |
为什么需要三个
代码注释只管代码。这三个文件管的是过程——做到哪了、卡在哪、有哪些雷还没排。
调试清单是进度。一看 checkbox 就知道哪些阶段过了、哪些还没测、哪些测了但没打勾。
待确认清单是阻塞项。"VCC Min = 3.2V 这个值怎么定的?等同事邮件"——这种信息代码里存不了、脑子会忘、记在待确认里跨会话不丢。
同步更新
代码改了、分支切了、新 bug 发现了——对应文档立刻更新。不是写完代码再补,是同步推进。一周后回来看文档和代码对不上,文档就废了。
有用的话点个收藏,下次调试直接用。有问题欢迎评论区交流,看到了都会回。
编程学习
技术分享
实战经验