claude_dev
9649e8a761
P0 (核心): - wiki-setup: 初始化 wiki vault - wiki-ingest: 蒸馏文档为 wiki 页面 - wiki-capture: 保存对话为 wiki 笔记 P1 (重要): - wiki-rebuild: 重建 wiki 索引 - data-ingest: 录入非结构化数据 - ingest-url: 抓取 URL 内容 - wiki-export: 导出知识图谱 P2 (可选): - wiki-research: 多轮搜索研究 - impl-validator: 验证实现 - graph-colorize: 着色 Obsidian 图形 - wiki-agent: 录入 agent 历史 Co-Authored-By: Claude Dev <noreply@anthropic.com>
187 lines
3.4 KiB
Markdown
187 lines
3.4 KiB
Markdown
---
|
||
name: impl-validator
|
||
description: 验证实现是否符合其声明目标（代码审查、架构验证）
|
||
trigger: 当用户需要验证代码实现或架构设计时
|
||
---
|
||
|
||
# Impl Validator
|
||
|
||
## 使用场景
|
||
- 代码实现验证
|
||
- 架构合规性检查
|
||
- PR 审查辅助
|
||
- 技术债务评估
|
||
|
||
## 操作步骤
|
||
|
||
1. **获取待验证内容**
|
||
- 代码文件或目录
|
||
- PR/Issue 描述
|
||
- 设计文档
|
||
|
||
2. **定义验证标准**
|
||
- 从 frontmatter 或文档中提取目标
|
||
- 确定验证维度
|
||
- 设置检查点
|
||
|
||
3. **执行验证**
|
||
- 代码审查
|
||
- 架构分析
|
||
- 测试覆盖率检查
|
||
|
||
4. **生成报告**
|
||
- 评分和发现
|
||
- 改进建议
|
||
- 存入 wiki
|
||
|
||
## 验证维度
|
||
|
||
| 维度 | 检查项 |
|
||
|-----|-------|
|
||
| **正确性** | 是否实现声明功能 |
|
||
| **性能** | 是否满足性能要求 |
|
||
| **安全** | 是否存在安全风险 |
|
||
| **可维护性** | 代码是否清晰易读 |
|
||
| **测试** | 是否有充分测试 |
|
||
| **文档** | 文档是否完整 |
|
||
|
||
## 页面模板
|
||
|
||
```markdown
|
||
---
|
||
name: impl-validation-YYYY-MM-DD
|
||
description: 实现验证报告
|
||
metadata:
|
||
type: synthesis | project
|
||
validated_at: YYYY-MM-DD
|
||
scope: <component-or-pr>
|
||
tags: [validation, review]
|
||
---
|
||
|
||
# 实现验证：<组件名称>
|
||
|
||
**日期**: YYYY-MM-DD
|
||
**范围**: <组件/PR>
|
||
**目标**: <声明的实现目标>
|
||
|
||
## 声明目标
|
||
<从文档或 issue 中提取的目标>
|
||
|
||
## 验证结果
|
||
|
||
### 正确性 ✅/⚠️/❌
|
||
- [x] 功能完整性
|
||
- [x] 边界情况处理
|
||
- [ ] 错误处理
|
||
|
||
### 性能 ✅/⚠️/❌
|
||
- [x] 满足性能要求
|
||
- [x] 无明显瓶颈
|
||
- [x] 资源使用合理
|
||
|
||
### 安全 ✅/⚠️/❌
|
||
- [x] 无已知漏洞
|
||
- [x] 输入验证充分
|
||
- [ ] 敏感数据处理
|
||
|
||
### 可维护性 ✅/⚠️/❌
|
||
- [x] 代码清晰
|
||
- [x] 命名规范
|
||
- [x] 适当注释
|
||
|
||
### 测试 ✅/⚠️/❌
|
||
- [x] 单元测试覆盖
|
||
- [ ] 集成测试
|
||
- [ ] 边界测试
|
||
|
||
### 文档 ✅/⚠️/❌
|
||
- [x] API 文档
|
||
- [x] 使用示例
|
||
- [ ] 架构说明
|
||
|
||
## 发现的问题
|
||
|
||
### 问题 1：中等
|
||
**描述**: ...
|
||
**位置**: file:line
|
||
**建议**: ...
|
||
|
||
### 问题 2：低
|
||
**描述**: ...
|
||
**位置**: file:line
|
||
**建议**: ...
|
||
|
||
## 改进建议
|
||
|
||
1. **高优先级**
|
||
- 建议 1
|
||
- 建议 2
|
||
|
||
2. **中优先级**
|
||
- 建议 3
|
||
|
||
## 总体评分
|
||
|
||
| 维度 | 评分 | 备注 |
|
||
|-----|------|------|
|
||
| 正确性 | 8/10 | ... |
|
||
| 性能 | 7/10 | ... |
|
||
| 安全 | 9/10 | ... |
|
||
| 可维护性 | 8/10 | ... |
|
||
| 测试 | 6/10 | ... |
|
||
| 文档 | 7/10 | ... |
|
||
|
||
**综合评分**: 7.5/10
|
||
|
||
## 相关链接
|
||
- [[related-practice]]
|
||
- [[component-doc]]
|
||
```
|
||
|
||
## 输出格式
|
||
|
||
```json
|
||
{
|
||
"success": true,
|
||
"scope": "component-name",
|
||
"saved_to": "projects/validation-component-2024-01-15.md",
|
||
"validation_summary": {
|
||
"overall_score": 7.5,
|
||
"dimensions": {
|
||
"correctness": 8,
|
||
"performance": 7,
|
||
"security": 9,
|
||
"maintainability": 8,
|
||
"testing": 6,
|
||
"documentation": 7
|
||
},
|
||
"issues_found": 3,
|
||
"improvements": 5
|
||
}
|
||
}
|
||
```
|
||
|
||
## MCP 集成
|
||
|
||
使用 MCP 工具：
|
||
- `wiki_query` - 查找相关实践
|
||
- `wiki_lint` - 检查代码质量
|
||
- `cross_linker` - 创建相关链接
|
||
|
||
## 配置选项
|
||
|
||
**`~/.sanguo-llmwiki/config.yaml`**：
|
||
```yaml
|
||
validation:
|
||
auto_save: true # 自动保存报告
|
||
include_code_snippets: true # 包含代码片段
|
||
suggest_improvements: true # 建议改进
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
1. 客观评价，避免主观偏见
|
||
2. 提供具体改进建议
|
||
3. 区分必需和可选改进
|
||
4. 保留验证历史用于对比
|