code-review-doc-generator

Files (6)

• SKILL.md
• metrics-guide.md · references/
• project-mapping.md · references/
• templates.md · references/
• validate_yaml.cpython-313.pyc · scripts/__pycache__/
• validate_yaml.py · scripts/

SKILL.md (first lines)

# Code Review Document Generator

自动化代码评审文档生成技能，支持 Git/SVN 双版本控制系统。在同一对话内完成首次和二次评审的完整闭环，用户确认后生成带多维效率指标的结构化评审文档。

## 核心设计理念

此工作流的核心价值在于 **量化 AI 评审效率**。相比人工评审，AI 评审的提效比例（代码评审提效）是衡量价值的核心指标。整个流程围绕"检测 → 提问 → 评审 → 迭代 → 生成 → 校验"六个阶段展开。

工作流区分两类评审场景：
- **类型 A（变更类）**：基于 VCS diff 的变更评审，需要交互提问收集元信息
- **类型 B（片段类）**：用户直接提供的代码片段/文件评审，跳过提问直接评审

> **📁 配套资源：** 文档模板在 `references/templates.md`，项目类型映射在 `references/project-mapping.md`，效率指标计算方法在 `references/metrics-guide.md`，YAML 校验脚本在 `scripts/validate_yaml.py`。

---

## 状态机（核心流程）

```
[INIT] → [DETECTED] → [QUESTIONED? 仅类型A] → [REVIEWING] → [COMPLETED]
```

关键约束：
- 类型 A 必须经过 QUESTIONED 状态（等待用户回答），禁止跳过
- 类型 B 从 DETECTED 直接到 REVIEWING
- 所有阶段 **静默执行**（不输出"正在检测"、"正在评审"等过程文字），仅在需要用户交互时输出固定模板
- 进入 COMPLETED 后立即生成文档，**禁止二次确认**"是否生成文档"

---

## Phase 0: 评审类型识别 (🔇 静默)

分析用户请求，判断评审类型，不输出任何过程信息。

**类型 A — 变更类评审：**
- Git 暂存区/工作区变更、commit diff、SVN 工作区修改
- 用户提及"变更"、"修改"、"提交"、"diff"、"stage" 等关键词

**类型 B — 代码片段类评审：**
- 用户直接粘贴代码、指定评审特定函数/文件
- 评审对象已在对话上下文中（当前打开文件/选中代码）
- 用户提及"函数"、"方法"、"这段代码"、"这个文件" 等关键词

默认规则：无法判断时按类型 A 处理。

---

## Phase 1: 环境检测与初始化 (🔇 静默)

> 详细的项目类型映射和 VCS 命令见 `references/project-mapping.md`。

### 1.1 VCS 检测

按顺序检测 `.git` → `.svn`，两者都不存在时提示用户切换到项目根目录。

### 1.2 发起人信息

- **Git**：`git config user.name` / `git config user.email`
- **SVN**：`svn auth` 或 `svn log -l 1 --quiet`
- 获取失败时在 Phase 2 提问中补充询问

### 1.3 项目类型识别

读取 `references/project-mapping.md` 中的映射表，按 Git Remote URL → SVN URL → AI 推断的顺序识别项目类型（候选：LP、DWSSDK、读码门、读码门SDK、单间分离、单间分离SDK、AA点胶、落格追溯IPC、落格追溯IPC前端、DFS、WPF公共控件、3D线激光SDK、其他）。

### 1.4 模块名称

根据文件路径、commit message、代码功能智能推断，在提问时展示给用户确认。

---

## Phase 2: 合并提问

**类型 A 必须执行，类型 B 自动跳过。**

### 类型 A 输出模板（逐字输出，禁止修改）

> 输出模板参见下方「交互文本汇总 → Phase 2 提问」。

回答中的"项目模块"决定文档标题，"是否AI辅助"和"AI开发耗时"决定是否计算开发效率指标。必须等待用户真实回复，禁止假设或自动填充。

### 类型 B 默认值

类型 B 自动使用 `AI辅助=否`，`AI开发耗时=不适用`，直接进入 Phase 3。

---

## Phase 3: 代码评审

### 3.1 获取变更 (🔇 静默)

**Git：**
```bash
git diff --cached --name-only
git diff --cached --shortstat
git diff --cached
```

**SVN：**
```bash
svn status
svn diff
```

### 3.2 评审维度

覆盖六个维度：代码规范性、潜在 Bug 和风险、性能问题、安全隐患、可维护性、最佳实践。

### 3.3 评审结果展示模板

```
【首次评审结果】

变更概览：{files}个文件，+{add}/-{del}行

### 严重问题 ({count})
1. {问题标题} - `{文件}:{行号}`

### 主要问题 ({count})

From Kevinlan888/skills, MIT.

More from Kevinlan888/skills