adr-creation

仓库创建 2026年7月4日最近提交 22 天前SkillHot 收录 22 天前

▸ 精选理由

自动维护机器可读与人类可读版本，方便代理与开发者协作。

这个 Skill 做什么

创建并同步 Markdown（源码）与 HTML（人类视图）两种格式的架构决策记录（ADR）。

同时产出 Markdown（源码、agent 用）和 HTML（给人看的富文本）两种格式的 ADR，并在更新时保持两者同步。适合记录架构决策、写权衡分析并向不同受众呈现时使用。Markdown 做为事实来源，HTML 提供图表与示例，能让机器与人都读得清楚。

▸ 展开 SKILL.md 英文原文

Creates and maintains dual-format ADRs — Markdown (source of truth for agents) and HTML (rich explainer for humans with diagrams). Keeps both formats in sync on updates. Use when user says "create an ADR", "document this decision", "write an ADR", "ADR for X", or when creating or updating a file in docs/adr/.

开发编程ADR文档同步决策记录通用

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/ceilidhboy/skills/master/skills/adr-creation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/ceilidhboy/skills/master/skills/adr-creation/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# ADR Creation (Dual Format)

## Core Principles

1. **Markdown (`docs/adr/YYYY-MM-DD-title.md`) is the source of truth.**
   - This is what AI agents read.
   - Concise, technical, captures the essence of the decision.

2. **HTML (`docs/adr/html/YYYY-MM-DD-title.html`) is the human-facing explainer.**
   - Richer, more detailed — includes SVG diagrams, explanatory prose, worked examples.
   - **Never a 1:1 translation of the markdown.** Expand freely to help non-technical humans understand.
   - Must convey the same information — never contradict the markdown — but go deeper on background, rationale, and visual presentation.

3. **Both files must stay in sync.** Updating an ADR means updati

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有