架构纪略
原名：documentation-and-adrs
记录决策和文档。在做出架构决策、更改公共 API、发布功能或需要记录未来工程师和智能体理解代码库所需上下文时使用。
- 分类
- 开发提效
- 版本
- v1.0.0
- 作者
- 陈澜(@user8vto8f)
- 下载
- 2
- 收藏
- 0
- 发布
- 2026-08-08
- 更新
- 2026-08-14
- TRACE 评分
- 3.6 / 5
内容概览
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. - 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 repeatedly When NOT to use: Don't document obvious code. Don't add comments that restate what the code already says. Don't write docs for throwaway prototypes. ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you…