mcpField
D
documenting-decisions

documenting-decisions

github.com/pandoscope开发11.9k 次安装5 周前更新
代码仓库

关于 documenting-decisions

用于记录代码中的重要开发决策并整理为审查摘要的技能，帮助开发者和编码 Agent 区分需审查的决定与常规改动，并指导 ADR 和工单同步。

主要功能

  1. 01六类决策检查标签
  2. 02生成 PR 决策日志
  3. 03ADR 后续处理指引
  4. 04任务完成后同步工单
  5. 05按类别标记差异块

适用场景

  1. 01标记架构或接口变更
  2. 02总结安全及不可逆改动
  3. 03按决策类别审查差异

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/pandoscope/skills --skill documenting-decisions

安装后在 Claude Code 中输入/documenting-decisions确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

README.md
references/
canary-signals.md
decision-markers.md
irreversible-operations.md
marker-examples.md
pre-approval-gate.md
scope-interpretation.md
security-protocol.md

详细介绍

记录决策

检查点标签

标签标记时机
ARCH新增抽象、依赖、数据模型、组件边界——任何会影响长期结构的内容。
SCOPE通过选择某种解释来消除任务中的歧义。
IFACE更改了公共 API、配置架构、CLI 标志、环境变量或线格式。
SEC涉及身份验证、加密、权限、网络暴露或输入验证。
IRREV创建了迁移、删除了数据、触发了部署或产生了外部副作用。
NOVEL没有可遵循的现有仓库模式——你根据训练数据推断并采用了做法。

常规更改（遵循既有模式、样板代码、重构）不要标记。

格式

请参阅此技能的 references/ decision-markers.md，以及（如有需要）marker-examples.md。

任务完成后

根据已更改文件中的标记生成决策日志，并添加到 PR 描述中：

## Decisions requiring review
- **TAG** `file:line` — explanation
## Routine (skip review)
[One-line summary]

如果 ARCH 或 IRREV 标记符合 writing-adrs 的标准（难以撤销、缺少上下文时令人意外，或源于真正的权衡），还应按照该技能编写 ADR。

同步驱动任务的工单

由工单驱动的工作 → 关闭前更新工单：纳入偏差、会话中的范围变更，以及上述决策（或其 ADR／术语表引用）。根据 to-tickets 的可复现性不变量，重放问题流应能构建最终状态，而不是初稿。

差异分类模式

用户要求审查差异时，将每个代码块归类为六种标签之一或 ROUTINE。按 File: path — TAG 的格式列出，并注明行范围。

参考文件

  • references/canary-signals.md — 用于自动检测检查点的 CI 脚本（仓库设置，不在运行时使用）。
  • references/marker-examples.md — 多种语言的标记示例。
  • references 中的其他文件仅在 AGENTS.md 中明确提及或用户要求时才相关。

评论

支持 Markdown