当前位置: 首页 > news >正文

嵌入式项目文档三件套——规则、清单、待办

一句话: 三个文件跟着项目走——CLAUDE.md 存规则(AI 自动读)、调试清单存进度(带 checkbox)、待确认存跨会话待办。代码改了这三个文件要同步更新。

适合谁读:嵌入式项目文档散落各处、换台机器就不知道做到哪的开发者。

三件套

文件内容谁读更新时机
CLAUDE.md编码约束、命名规则、流程、禁止项AI 每次会话自动加载规则变了或踩了新坑
上板调试流程.md分阶段带 checkbox 的调试清单人 + AI每过一阶段打勾
待确认事项.md跨状态的阻塞项(硬件标定、同事配合、发货检查)人 + AI有新待确认立即加

为什么需要三个

代码注释只管代码。这三个文件管的是过程——做到哪了、卡在哪、有哪些雷还没排。

调试清单是进度。一看 checkbox 就知道哪些阶段过了、哪些还没测、哪些测了但没打勾。

待确认清单是阻塞项。"VCC Min = 3.2V 这个值怎么定的?等同事邮件"——这种信息代码里存不了、脑子会忘、记在待确认里跨会话不丢。

同步更新

代码改了、分支切了、新 bug 发现了——对应文档立刻更新。不是写完代码再补,是同步推进。一周后回来看文档和代码对不上,文档就废了。


有用的话点个收藏,下次调试直接用。有问题欢迎评论区交流,看到了都会回。

http://www.jsqmd.com/news/1294683/

相关文章:

  • 高速PCB设计中的绕等长:原理、实战与Altium Designer技巧
  • C++20 ranges自定义序列适配:哨兵与迭代器实践指南
  • 2026年沈阳活性炭选购攻略:沈民活性炭厂及国内优质企业盘点 - 品牌推荐达人
  • 半导体FAB制造术语体系:新人工程师快速入门指南
  • 2026年7月烟台芝罘区马桶地漏堵了怎么办?找本地金池管道疏通避坑指南 - 余生黄金回收
  • 2026 AIGEO 排名优化全攻略:从原理到实战,让 AI 优先引用你的内容
  • KRAS[G12D]突变体的靶向降解技术与临床转化
  • Python+Flask构建动漫数据可视化系统实战
  • 介观尺度电子输运:从量子效应到纳米器件设计实践
  • Python闭包与装饰器:提升代码质量的魔法工具
  • 在铜陵同样 85㎡老房翻新,报价差 3 万!一篇全解析 - 博客万
  • 通用LLM验证框架:实现大模型自动化评估与性能缩放
  • Total Registry:专业Windows注册表编辑器终极替代方案
  • OpenCV cv::Exception异常调试指南:从捕获到根治的完整解决方案
  • 2026 衡东装修口碑榜单|深耕多年,衡东百盛装饰凭精工与诚信服务收获衡东业主一致好评 - 推途云
  • 散拼大团,2-6人小包团,一家一团定制游区别 8 月北京旅游团型选择全攻略 - 资讯快报
  • 研发项目管理四维控制法与高效工具链实践
  • 2026 沈阳秋森映像婚纱照深度测评:客片质感、服务实情与真实口碑拆解 - 章鱼智讯
  • Agent 可靠性工程实战(一):先给智能循环装一只不可失忆的黑匣子
  • 计算机毕业设计之基于SpringBootvue的特色服装租赁管理系统
  • Houdini程序化道路生成:UE4/UE5城市自动化建模全流程解析
  • 基于NSGA-Ⅲ的梯级水电与火电联合调度优化实践
  • 基于SpringBoot+Vue的宠物领养系统设计与实现开题报告
  • Flutter在鸿蒙平台的开发实践与性能优化
  • Unity游戏开发:Animated Water Textures Pack水面纹理包实战应用与优化指南
  • 3分钟掌握全网视频资源下载神器:res-downloader终极指南
  • 2026年常州无锡GEO问答优化专业公司推荐:中之网科技 - 起跑123
  • NanaZip:Windows上最强大的免费文件压缩工具,7-Zip的现代化替代品
  • 探秘高性价比铁观音,哪家茶厂最值得信赖? - 资讯快报
  • 中润 AI 数字人直播系统,开启全域智能直播新时代 - 资讯快报