docs-and-adr-zh

架构决策记录（ADR）、技术文档、README 结构、注释规范、API 文档。适用于以下场景：当用户询问“这个技术选型要不要记下来”“写一份 ADR”“为什么当初选了 X 没人记得”“README 怎么写”“注释应该写什么”“接口文档怎么组织”“给 AI 用的项目规则文件怎么写”时。 核心原则：记录决策而不仅仅是代码——需包含上下文、约束条件、被否决的备选方案；明确 ADR 的编写时机、优先匹配仓库已有约定、使用统一模板并管理其生命周期；注释只写“为什么”（why），不写“是什么”（what）；已知问题或陷阱应直接写在相关代码旁；README 采用五段式结构；维护 Changelog；为 Agent（AI 代理）编写专用文档。 改编自 addyosmani/agent-skills 的 documentation-and-adrs（MIT 许可）。

存档时间线

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本