Back to Details

review-core

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Core Review Workflow

核心评审工作流

Table of Contents

目录

  1. When to Use
  2. Activation Patterns
  3. Required TodoWrite Items
  4. Step 1 – Establish Context
  5. Step 2 – Inventory Scope
  6. Step 3 – Capture Evidence
  7. Step 4 – Structure Deliverables
  8. Step 5 – Contingency Plan
  9. Troubleshooting
  1. 适用场景
  2. 触发模式
  3. 必填TodoWrite项
  4. 步骤1 – 确定上下文
  5. 步骤2 – 梳理评审范围
  6. 步骤3 – 留存证据
  7. 步骤4 – 结构化交付物
  8. 步骤5 – 应急预案
  9. 问题排查

When To Use

适用场景

  • Use this skill at the beginning of any detailed review workflow (e.g., for architecture, math, or an API).
  • It provides a consistent structure for capturing context, logging evidence, and formatting the final report, which makes the findings of different reviews comparable.
  • 在任何详细评审工作流（例如架构、数学问题或API评审）启动时使用本技能
  • 它提供了统一的结构来记录上下文、留存证据、格式化最终报告，让不同评审的发现具备可比性。

When NOT To Use

不适用场景

  • Diff-focused analysis - use diff-analysis
  • 聚焦差异的分析场景，请使用diff-analysis

Activation Patterns

触发模式

Trigger Keywords: review, audit, analysis, assessment, evaluation, inspection Contextual Cues:
  • "review this code/design/architecture"
  • "conduct an audit of"
  • "analyze this for issues"
  • "evaluate the quality of"
  • "perform an assessment"
Auto-Load When: Any review-specific workflow is detected or when analysis methodologies are requested.
触发关键词: review, audit, analysis, assessment, evaluation, inspection 上下文提示:
  • "review this code/design/architecture"
  • "conduct an audit of"
  • "analyze this for issues"
  • "evaluate the quality of"
  • "perform an assessment"
自动触发条件: 检测到任何特定评审工作流，或用户请求分析方法论时自动加载。

Required TodoWrite Items

必填TodoWrite Items

  1. review-core:context-established
  2. review-core:scope-inventoried
  3. review-core:evidence-captured
  4. review-core:deliverables-structured
  5. review-core:contingencies-documented
  1. review-core:context-established
  2. review-core:scope-inventoried
  3. review-core:evidence-captured
  4. review-core:deliverables-structured
  5. review-core:contingencies-documented

Step 1 – Establish Context (
review-core:context-established
)

步骤1 – 确定上下文 (
review-core:context-established
)

  • Confirm 
    pwd
    , repo, branch, and upstream base (e.g., 
    git status -sb
    , 
    git rev-parse --abbrev-ref HEAD
    ).
  • Note comparison target (merge base, release tag) so later diffs reference a concrete range.
  • Summarize the feature/bug/initiative under review plus stakeholders and deadlines.
  • 确认
    pwd
    、仓库、分支和上游基准（例如
    git status -sb
    、
    git rev-parse --abbrev-ref HEAD
    ）。
  • 记录对比目标（合并基准、发布标签），方便后续差异分析引用具体的版本范围。
  • 总结待评审的功能/缺陷/项目，以及相关干系人和截止时间。

Step 2 – Inventory Scope (
review-core:scope-inventoried
)

步骤2 – 梳理评审范围 (
review-core:scope-inventoried
)

  • List relevant artifacts for this review: source files, configs, docs, specs, generated assets (OpenAPI, Makefiles, ADRs, notebooks, etc.).
  • Record how you enumerated them (commands like 
    rg --files -g '*.mk'
    , 
    ls docs
    , 
    cargo metadata
    ).
  • Capture assumptions or constraints inherited from the plan/issue so the domain-specific analysis can cite them.
  • 列出本次评审相关的产物：源代码文件、配置、文档、规范、生成的资源（OpenAPI、Makefiles、ADRs、notebooks等）。
  • 记录你枚举这些产物的方式（使用的命令如
    rg --files -g '*.mk'
    、
    ls docs
    、
    cargo metadata
    ）。
  • 记录从计划/issue中继承的假设或约束，方便后续领域特定分析时引用。

Step 3 – Capture Evidence (
review-core:evidence-captured
)

步骤3 – 留存证据 (
review-core:evidence-captured
)

  • Log every command/output that informs the review (e.g., 
    git diff --stat
    , 
    make -pn
    , 
    cargo doc
    , 
    web.run
    citations). Keep snippets or line numbers for later reference.
  • Track open questions or variances found during preflight; if they block progress, record owners/timelines now.
  • 记录所有为评审提供依据的命令/输出（例如
    git diff --stat
    、
    make -pn
    、
    cargo doc
    、
    web.run
    引用），保留代码片段或行号方便后续参考。
  • 跟踪预检过程中发现的未解决问题或差异，如果它们阻塞了进度，立即记录负责人和处理时间线。

Step 4 – Structure Deliverables (
review-core:deliverables-structured
)

步骤4 – 结构化交付物 (
review-core:deliverables-structured
)

  • Prepare the reporting skeleton shared by all reviews:
    • Summary (baseline, scope, recommendation)
    • Ordered findings (severity, file:line, principle violated, remediation)
    • Follow-up tasks (owner + due date)
    • Evidence appendix (commands, URLs, notebooks)
  • validate the domain-specific checklist will populate each section before concluding.
  • 准备所有评审通用的报告框架：
    • 摘要（基准、范围、建议）
    • 有序排列的发现（严重等级、文件:行号、违反的原则、修复方案）
    • 后续任务（负责人 + 截止日期）
    • 证据附录（命令、URL、notebooks）
  • 在结束前确认领域特定检查清单可以填充每个部分。

Step 5 – Contingency Plan (
review-core:contingencies-documented
)

步骤5 – 应急预案 (
review-core:contingencies-documented
)

  • If a required tool or skill is unavailable (e.g., 
    web.run
    ), document the alternative steps that will be taken and any limitations this introduces. This helps reviewers understand any gaps in coverage.
  • Note any outstanding approvals or data needed to complete the review.
  • 如果所需的工具或技能不可用（例如
    web.run
    ），记录将采用的替代步骤以及由此带来的限制，帮助评审人员理解评审覆盖范围的缺口。
  • 记录完成评审所需的未完成审批或缺失数据。

Exit Criteria

退出标准

  • All TodoWrite items complete with concrete notes (commands run, files listed, evidence paths).
  • Domain-specific review can now assume consistent context/evidence/deliverable scaffolding and focus on specialized analysis.
  • 所有TodoWrite项都已完成，附带具体记录（运行的命令、列出的文件、证据路径）。
  • 领域特定评审现在可以基于统一的上下文/证据/交付物框架，聚焦于专业分析。

Troubleshooting

问题排查

Common Issues

常见问题

Command not found Ensure all dependencies are installed and in PATH
Permission errors Check file permissions and run with appropriate privileges
Unexpected behavior Enable verbose logging with 
--verbose
flag
命令未找到 确保所有依赖已安装且已添加到PATH中
权限错误 检查文件权限，使用合适的权限运行
异常行为 使用
--verbose
参数启用详细日志