技术文档与架构决策记录
原名:documentation-and-adrs
把公共接口、架构选择和重要变更整理成可维护的技术文档。
中文 Skills 技能说明
用于记录为什么这样设计、有哪些取舍、接口如何使用以及后续如何演进。文档应与当前代码和真实行为一致,不能把计划中的功能写成已经完成。
上游能力依据
上游原始适用说明:Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
上游 SKILL.md 主要章节(保留原文标题):
- Overview
- When to Use
- Architecture Decision Records (ADRs)
- When to Write an ADR
- Match the existing convention first
- ADR Template
- Status
- Date
- Context
- Decision
使用边界
先读取项目约定、依赖版本和现有测试,再提出最小改动。写文件、运行脚本、提交代码或发布前应检查差异并保留回退路径。
作者、翻译与许可证
- 原作者
- Addy Osmani
- 中文翻译
- CEOFans翻译
- 许可证
- MIT
- 上游来源
- https://github.com/addyosmani/agent-skills/tree/f49337711b7a932b4b338c1d4ad73384df8fd87d/skills/documentation-and-adrs
适用范围
平台:linux、macos、windows;标签:Documentation、ADRs、Decisions
安全提示
基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件,请在最小权限环境中使用,高风险操作必须人工确认。
如发现侵权、许可证或安全问题,可在本页前台提交投诉,管理员复核后可立即下架。