mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-02 15:23:19 +08:00
Add Chinese documentation for custom skills development and reference guide
- Created a new document for custom skills development (`custom.md`) detailing the structure, creation, implementation, and best practices for developing custom CCW skills. - Added an index document (`index.md`) summarizing all built-in skills, their categories, and usage examples. - Introduced a reference guide (`reference.md`) providing a quick reference for all 33 built-in CCW skills, including triggers and purposes.
This commit is contained in:
190
docs/skills/specs/quality-standards.md
Normal file
190
docs/skills/specs/quality-standards.md
Normal file
@@ -0,0 +1,190 @@
|
||||
# Quality Standards
|
||||
|
||||
> 本文档定义 CCW Skills 审查的质量标准和评分规则。
|
||||
|
||||
## 概述
|
||||
|
||||
质量标准确保审查过程的规范性和审查结果的一致性。审查者应遵循此标准进行审查。
|
||||
|
||||
## 审查者资格
|
||||
|
||||
### 必需能力
|
||||
|
||||
| 能力 | 要求 |
|
||||
|------|------|
|
||||
| 代码理解 | 能够理解代码逻辑和设计意图 |
|
||||
| 标准掌握 | 熟悉本质量标准和相关规范 |
|
||||
| 语言能力 | 代码编写语言的熟练度 |
|
||||
| 架构理解 | 理解系统架构和设计模式 |
|
||||
|
||||
### 培训要求
|
||||
|
||||
- 新审查者必须完成审查培训
|
||||
- 每季度参加标准更新培训
|
||||
- 参与审查校准会议
|
||||
|
||||
---
|
||||
|
||||
## 审查过程标准
|
||||
|
||||
### 1. 准备阶段
|
||||
|
||||
- ✅ 阅读 `specs/review-dimensions.md`
|
||||
- ✅ 阅读 `specs/issue-classification.md`
|
||||
- ✅ 了解被审查代码的上下文
|
||||
|
||||
### 2. 快速扫描阶段
|
||||
|
||||
- 扫描所有文件,识别高风险区域
|
||||
- 标记明显的问题(Critical/High)
|
||||
- 评估整体代码质量
|
||||
|
||||
**时间限制**: 5-10 分钟
|
||||
|
||||
### 3. 深度审查阶段
|
||||
|
||||
- 逐个维度进行审查
|
||||
- 记录发现的问题
|
||||
- 提供具体的修复建议
|
||||
|
||||
**时间限制**: 20-40 分钟
|
||||
|
||||
### 4. 报告生成阶段
|
||||
|
||||
- 汇总所有发现
|
||||
- 生成结构化报告
|
||||
- 提供修复优先级
|
||||
|
||||
---
|
||||
|
||||
## 审查质量评分
|
||||
|
||||
### 审查完整性
|
||||
|
||||
| 检查项 | 权重 | 标准 |
|
||||
|--------|------|------|
|
||||
| 覆盖所有维度 | 30% | 6 个维度全部审查 |
|
||||
| 高风险区域识别 | 20% | 快速扫描识别关键问题 |
|
||||
| 问题记录详细 | 25% | 每个问题包含位置、描述、建议 |
|
||||
| 报告格式规范 | 15% | 符合报告模板 |
|
||||
| 修复建议可执行 | 10% | 建议具体可操作 |
|
||||
|
||||
**最低要求**: 70/100
|
||||
|
||||
---
|
||||
|
||||
## 问题发现率标准
|
||||
|
||||
### 期望发现率
|
||||
|
||||
| 严重性 | 期望发现率 | 说明 |
|
||||
|--------|-----------|------|
|
||||
| Critical | 100% | 所有 Critical 问题必须发现 |
|
||||
| High | ≥ 90% | 大部分 High 问题应发现 |
|
||||
| Medium | ≥ 60% | 主要 Medium 问题应发现 |
|
||||
| Low | ≥ 30% | 部分 Low 问题应发现 |
|
||||
|
||||
### 质量验证
|
||||
|
||||
通过以下方式验证审查质量:
|
||||
|
||||
1. **交叉审查**: 重要 PR 由多人审查
|
||||
2. **审查回顾**: 定期回顾审查质量
|
||||
3. **问题追踪**: 审查遗漏问题的跟踪
|
||||
|
||||
---
|
||||
|
||||
## 审查效率标准
|
||||
|
||||
### 时间标准
|
||||
|
||||
| 代码规模 | 预期时间 |
|
||||
|----------|----------|
|
||||
| 小型 (< 200 行) | 15-20 分钟 |
|
||||
| 中型 (200-500 行) | 30-40 分钟 |
|
||||
| 大型 (500-1000 行) | 60-80 分钟 |
|
||||
| 超大 (> 1000 行) | 分批审查 |
|
||||
|
||||
### 响应时间
|
||||
|
||||
| 优先级 | 响应时间 |
|
||||
|--------|----------|
|
||||
| 紧急 (P0) | 2 小时内 |
|
||||
| 高 (P1) | 1 个工作日内 |
|
||||
| 正常 (P2) | 2 个工作日内 |
|
||||
| 低 (P3) | 1 周内 |
|
||||
|
||||
---
|
||||
|
||||
## 审查行为规范
|
||||
|
||||
### 应该做 ✅
|
||||
|
||||
- 提供建设性反馈
|
||||
- 解释问题原因
|
||||
- 给出具体修复建议
|
||||
- 认可好的代码实践
|
||||
- 保持礼貌和专业
|
||||
|
||||
### 不应该做 ❌
|
||||
|
||||
- 攻击性语言
|
||||
- 模糊的批评
|
||||
- 只提问题不提建议
|
||||
- 忽视上下文
|
||||
- 延迟审查无反馈
|
||||
|
||||
---
|
||||
|
||||
## 报告质量检查清单
|
||||
|
||||
### 完整性检查
|
||||
|
||||
- [ ] 所有 6 个维度已审查
|
||||
- [ ] Critical/High 问题已记录
|
||||
- [ ] 每个问题包含位置信息
|
||||
- [ ] 每个问题有修复建议
|
||||
- [ ] 报告格式符合模板
|
||||
|
||||
### 准确性检查
|
||||
|
||||
- [ ] 问题严重性分类正确
|
||||
- [ ] 问题描述准确无误
|
||||
- [ ] 修复建议可行有效
|
||||
- [ ] 代码示例正确
|
||||
|
||||
### 可行性检查
|
||||
|
||||
- [ ] 修复建议可执行
|
||||
- [ ] 优先级排序合理
|
||||
- [ ] 工作量评估合理
|
||||
|
||||
---
|
||||
|
||||
## 审查者绩效
|
||||
|
||||
### KPI 指标
|
||||
|
||||
| 指标 | 目标值 |
|
||||
|------|--------|
|
||||
| 审查响应时间 | < 2 个工作日 |
|
||||
| 问题发现率 | High 级别 ≥ 90% |
|
||||
| 报告质量评分 | ≥ 80/100 |
|
||||
| 修复建议采纳率 | ≥ 70% |
|
||||
|
||||
### 改进计划
|
||||
|
||||
未达标的审查者应:
|
||||
|
||||
1. 参加额外培训
|
||||
2. 接受导师指导
|
||||
3. 参与审查校准
|
||||
4. 定期自我评估
|
||||
|
||||
---
|
||||
|
||||
## 参考
|
||||
|
||||
- [Review Dimensions](review-dimensions.md)
|
||||
- [Issue Classification](issue-classification.md)
|
||||
- [Document Standards](document-standards.md)
|
||||
Reference in New Issue
Block a user