documentation-and-adrs

仓库创建 2026年2月16日最近提交 21 小时前SkillHot 收录 20 天前
▸ 精选理由

让未来工程师和智能代理理解设计取舍与历史脉络。

这个 Skill 做什么

记录架构决策与关键上下文,保存为何这样实现的理由。

把重要的架构决策和关键背景写清楚(比如 ADRs),记录为什么这么做、有哪些权衡和备选方案。每次改 API、上线功能或做重要设计时都该写,方便未来工程师和审查者快速理解来龙去脉。重点不是复述代码,而是保存决策的理由,省去日后反复问询。

▸ 展开 SKILL.md 英文原文

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.

开发编程文档架构决策ADR通用
8.1w
Stars
8.7k
Forks
24
仓库内 Skill
+10.0k
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/addyosmani/agent-skills/main/skills/documentation-and-adrs/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/addyosmani/agent-skills/main/skills/documentation-and-adrs/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# Documentation and ADRs

## Overview

Document decisions, not just code. The most valuable documentation captures the *why* — the context, constraints, and trade-offs that led to a decision. Code shows *what* was built; documentation explains *why it was built this way* and *what alternatives were considered*. This context is essential for future humans and agents working in the codebase.

## When to Use

- Making a significant architectural decision
- Choosing between competing approaches
- Adding or changing a public API
- Shipping a feature that changes user-facing behavior
- Onboarding new team members (or agents) to the project
- When you find yourself explaining the same thing repeate
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有