mcpField
P
project-analyze

project-analyze

github.com/catlog22开发2.1k45 次安装19 周前更新
代码仓库

关于 project-analyze

project-analyze 是一项通过多阶段迭代生成软件项目分析报告的技能。它支持架构、设计、方法及综合报告,并整合多个专门 Agent 的分析结果。

主要功能

  1. 01分阶段收集需求并探索项目
  2. 02生成架构、设计和方法报告
  3. 03由专门 Agent 并行分析
  4. 04跨章节汇总与质量检查
  5. 05生成 Markdown 报告

适用场景

  1. 01记录项目架构
  2. 02梳理设计模式与接口
  3. 03追踪算法和关键代码路径

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/catlog22/claude-code-workflow --skill project-analyze

安装后在 Claude Code 中输入/project-analyze确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

phases/
01-requirements-discovery.md
02-project-exploration.md
03-deep-analysis.md
03.5-consolidation.md
04-report-generation.md
05-iterative-refinement.md
specs/
quality-standards.md
writing-style.md

详细介绍

项目分析技能

通过多阶段迭代工作流生成全面的项目分析报告。

架构概览

┌─────────────────────────────────────────────────────────────────┐
│  Context-Optimized Architecture                                  │
├─────────────────────────────────────────────────────────────────┤
│                                                                  │
│  Phase 1: Requirements      → analysis-config.json              │
│           ↓                                                      │
│  Phase 2: Exploration       → 初步探索,确定范围                  │
│           ↓                                                      │
│  Phase 3: Parallel Agents   → sections/section-*.md (直接写MD)   │
│               ↓ 返回简要JSON                                     │
│  Phase 3.5: Consolidation   → consolidation-summary.md          │
│           Agent                 ↓ 返回质量评分+问题列表          │
│           ↓                                                      │
│  Phase 4: Assembly          → 合并MD + 质量附录                  │
│           ↓                                                      │
│  Phase 5: Refinement        → 最终报告                           │
│                                                                  │
└─────────────────────────────────────────────────────────────────┘

核心设计原则

  1. Agent 直接输出 MD:避免 JSON → MD 转换带来的上下文开销
  2. 简要返回:Agent 只返回路径和摘要,不返回完整内容
  3. 汇总 Agent:由独立 Agent 负责跨章节问题检测和质量评分
  4. 合并引用:第 4 阶段读取文件并进行合并,不在上下文中传递内容
  5. 段落式描述:禁止罗列清单,采用层层递进、客观的学术表达

执行流程

┌─────────────────────────────────────────────────────────────────┐
│  Phase 1: Requirements Discovery                                │
│  → Read: phases/01-requirements-discovery.md                    │
│  → Collect: report type, depth level, scope, focus areas        │
│  → Output: analysis-config.json                                 │
├─────────────────────────────────────────────────────────────────┤
│  Phase 2: Project Exploration                                   │
│  → Read: phases/02-project-exploration.md                       │
│  → Launch: parallel exploration agents                          │
│  → Output: exploration context for Phase 3                      │
├─────────────────────────────────────────────────────────────────┤
│  Phase 3: Deep Analysis (Parallel Agents)                       │
│  → Read: phases/03-deep-analysis.md                             │
│  → Reference: specs/quality-standards.md                        │
│  → Each Agent: 分析代码 → 直接写 sections/section-*.md          │
│  → Return: {"status", "output_file", "summary", "cross_notes"}  │
├─────────────────────────────────────────────────────────────────┤
│  Phase 3.5: Consolidation (New!)                                │
│  → Read: phases/03.5-consolidation.md                           │
│  → Input: Agent 返回的简要信息 + cross_module_notes             │
│  → Analyze: 一致性/完整性/关联性/质量检查                        │
│  → Output: consolidation-summary.md                             │
│  → Return: {"quality_score", "issues", "stats"}                 │
├─────────────────────────────────────────────────────────────────┤
│  Phase 4: Report Generation                                     │
│  → Read: phases/04-report-generation.md                         │
│  → Check: 如有 errors,提示用户处理                              │
│  → Merge: Executive Summary + sections/*.md + 质量附录          │
│  → Output: {TYPE}-REPORT.md                                     │
├─────────────────────────────────────────────────────────────────┤
│  Phase 5: Iterative Refinement                                  │
│  → Read: phases/05-iterative-refinement.md                      │
│  → Reference: specs/quality-standards.md                        │
│  → Loop: 发现问题 → 提问 → 修复 → 重新检查                       │
└─────────────────────────────────────────────────────────────────┘

报告类型

类型输出Agent 数量侧重点
architectureARCHITECTURE-REPORT.md5系统结构、模块、依赖关系
designDESIGN-REPORT.md4设计模式、类、接口
methodsMETHODS-REPORT.md4算法、关键路径、API
comprehensiveCOMPREHENSIVE-REPORT.md全部以上内容的综合

各报告类型的 Agent 配置

架构报告
Agent输出文件章节
overviewsection-overview.md系统概览
layerssection-layers.md层级分析
dependenciessection-dependencies.md模块依赖关系
dataflowsection-dataflow.md数据流
entrypointssection-entrypoints.md入口点
设计报告
Agent输出文件章节
patternssection-patterns.md设计模式
classessection-classes.md类关系
interfacessection-interfaces.md接口契约
statesection-state.md状态管理
方法报告
Agent输出文件章节
algorithmssection-algorithms.md核心算法
pathssection-paths.md关键代码路径
apissection-apis.md公共 API 参考
logicsection-logic.md复杂逻辑

目录设置

// 生成时间戳目录名
const timestamp = new Date().toISOString().slice(0,19).replace(/[-:T]/g, '');
const dir = `.workflow/.scratchpad/analyze-${timestamp}`;

// Windows (cmd)
Bash(`mkdir "${dir}\\sections"`);
Bash(`mkdir "${dir}\\iterations"`);

// Unix/macOS
// Bash(`mkdir -p "${dir}/sections" "${dir}/iterations"`);

输出结构

.workflow/.scratchpad/analyze-{timestamp}/
├── analysis-config.json          # Phase 1
├── sections/                     # Phase 3 (Agent 直接写入)
│   ├── section-overview.md
│   ├── section-layers.md
│   ├── section-dependencies.md
│   └── ...
├── consolidation-summary.md      # Phase 3.5
├── {TYPE}-REPORT.md              # Final Output
└── iterations/                   # Phase 5
    ├── v1.md
    └── v2.md

参考文档

文档用途
phases/01-requirements-discovery.md用户交互、配置收集
phases/02-project-exploration.md初步探索
phases/03-deep-analysis.md并行 Agent 分析
phases/03.5-consolidation.md跨章节整合
phases/04-report-generation.md报告组装
phases/05-iterative-refinement.md质量优化
specs/quality-standards.md质量门槛、标准
specs/writing-style.md段落式学术写作规范
../_shared/mermaid-utils.md共享 Mermaid 工具集

评论

支持 Markdown