documenting-decisions

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documenting Decisions

决策记录

Checkpoint tags

检查点标签

TagWhen to mark
ARCH
New abstractions, deps, data models, component boundaries — anything that shapes long-term structure.
SCOPE
You resolved an ambiguity in the task by choosing an interpretation.
IFACE
Changed a public API, config schema, CLI flag, env var, or wire format.
SEC
Touched auth, crypto, permissions, network exposure, or input validation.
IRREV
Created a migration, data deletion, deployment trigger, or external side effect.
NOVEL
No existing repo pattern to follow — you interpolated from training data.
Do not mark routine changes (pattern-following, boilerplate, refactoring).
Tag标记时机
ARCH
新的抽象概念、依赖项、数据模型、组件边界——任何影响长期架构的内容。
SCOPE
通过选择一种解释来解决任务中的歧义。
IFACE
修改了公共API、配置 schema、CLI 标志、环境变量或 wire format。
SEC
涉及身份验证、加密、权限、网络暴露或输入验证相关内容。
IRREV
创建了迁移、数据删除、部署触发器或外部副作用操作。
NOVEL
没有现有仓库模式可遵循——从训练数据中推导实现。
请勿标记常规变更(遵循模式、样板代码、重构)。

Format

格式

See this skill's
references/
decision-markers.md
and (if needed)
marker-examples.md
.
请查看本skill的
references/
目录下的
decision-markers.md
,必要时可查看
marker-examples.md

After task completion

任务完成后

Generate decision log from markers in changed files and add to PR description:
undefined
从变更文件中的标记生成决策日志,并添加到PR描述中:
undefined

Decisions requiring review

Decisions requiring review

  • TAG
    file:line
    — explanation
  • TAG
    file:line
    — explanation

Routine (skip review)

Routine (skip review)

[One-line summary]
undefined
[One-line summary]
undefined

Diff classification mode

差异分类模式

When user requests review of diff, classify each hunk as one of the six tags or
ROUTINE
. Present as
File: path — TAG
with line ranges.
当用户请求审查代码差异时,将每个代码块归类为六个标签之一或
ROUTINE
。以
File: path — TAG
格式呈现,并附带行号范围。

Reference files

参考文件

  • references/canary-signals.md
    — CI scripts for automated checkpoint detection (repo setup, not runtime).
  • references/marker-examples.md
    — example markers in multiple languages.
  • other files in references are only relevant if explicitly mentioned in AGENTS.md or requested by the user.
  • references/canary-signals.md
    — 用于自动检查点检测的CI脚本(仓库配置,非运行时)。
  • references/marker-examples.md
    — 多语言示例标记。
  • references目录中的其他文件仅在AGENTS.md中明确提及或用户请求时才相关。