一个为小型团队生成轻量级架构决策记录(ADR)的工具,聚焦于背景、决策、后果和状态。

Stars

25

7 天增长

暂无数据

Fork 数

17

开放 Issue

0

开源协议

MIT

最近更新

2026-07-29

AI 仓库情报摘要
FR-AI / ANALYSIS

为什么值得关注

它通过可配置选项简化了 ADR 的创建,并针对经常忽略架构文档的小型团队,帮助他们维护持久的记录。

适合谁使用

  • 小型软件团队
  • 软件架构师
  • 开发者
  • 技术负责人

典型使用场景

  • 记录技术栈/库/协议决策
  • 记录跨团队选择某方案的理由
  • 用新决策取代旧决策
  • 创建轻量级类 RFC 的 ADR

项目优势

  • 简洁的格式,小型团队易于维护
  • 可配置选项(语言、格式、状态、编号风格、详细程度)
  • 关注后果和状态,便于决策跟踪
  • 采用 MIT 许可证,可通过 npx 轻松安装

使用前须知

  • 仅适用于小型团队场景,可能不适用于企业级 RFC
  • 需要 npx 安装和外部技能管理工具
  • 不支持完整的多选项 RFC(建议使用单独的 rfc-outline 技能)

README 快速开始

ADR Writer

Write lightweight Architecture Decision Records for small teams: context → decision → consequences → status.

中文简介: 小型团队 ADR(背景→决策→后果→状态)。 — 详见 README.zh.md.

What this skill does

  • You produce short, durable ADRs small teams actually maintain
  • Scope: Small-team software architecture & tooling choices
  • Deliverable: One ADR page with status + consequences
  • Triggers: ADR, architecture decision record, tech decision log, RFC-lite ADR.

Install

After this package is on GitHub:

npx skills add / --skill adr-writer

Local monorepo: point your agent at skills/adr-writer/ (this folder).

Options

OptionValuesDefault
langen · zh · bilingualen
formatmadr · nygard · onepagernygard
statusproposed · accepted · deprecated · supersededproposed
id_stylesequential · date · nonesequential
depthlite · standardstandard

Runtime output language follows lang (default en). Skill docs stay EN-primary.

When to use

UseDon't
(see bullets)(see bullets)

Use

  • Stack/library/protocol decisions
  • Cross-team “why we chose X”
  • Superseding an old decision

Don't

  • Daily task tickets
  • Full multi-option RFC (use rfc-outline)
  • Inventing decisions without stakeholders

Deliverable

One ADR page with status + consequences

Full workflow, hard rules, and QA: see SKILL.md.

Example

Monorepo sample (if present): ../../output/samples/adr-writer-example-01.md

License

MIT — see LICENSE.

Attribution

Forged with skill-github (local package; push via external tool). Upstream notes may live in workspace AUTHORS.md / sources/.

相关仓库与替代方案

根据分类、Topic 和编程语言匹配的相似项目。

MoonshotAI
精选
MoonshotAI GitHub avatar

Kimi-K3

Kimi K3 is an open-weight, 2.8T-parameter native multimodal agentic model with a 1M-token context window, designed for frontier coding, knowledge work, and reasoning tasks.

AI 与机器学习AI 智能体
3,348
xuchonglang
精选
xuchonglang GitHub avatar

investing-for-beginners

A structured investing guide for Chinese beginners covering US stocks, options, and cryptocurrency, with focus on foundational concepts and risk awareness.

区块链与 Web3
2,739
Krishnagangwal
精选
Krishnagangwal GitHub avatar

CS-Fundamentals

A curated collection of Computer Science fundamentals (PDFs, notes, cheatsheets, interview question banks) for placement preparation, covering seven core subjects plus general resources.

数据与数据库数据库与存储
2,326