project-analyzer

Installation
SKILL.md

Project Analyzer — 代码仓库梳理

概述

此技能用于系统性梳理代码仓库,生成结构化的项目文档。通过分阶段探索代码仓——从宏观架构到微观功能流程——最终输出一份按模板组织的 Markdown 文档,帮助用户快速理解项目的定位、架构、业务流程和接口细节。

文档设计理念:流程与接口分离。功能模块章节聚焦"业务流程理解"(text 流程图对标代码 + mermaid 流程图可视化流转),接口的入参/返回值等技术细节统一汇总到最后的接口文档章节,避免流程阅读被接口字段表格打断。

触发条件

仅在用户明确要求时触发,包括但不限于:

  • 用户说"梳理项目"、"梳理一下这个项目"、"帮我梳理项目"
  • 用户说"使用项目梳理"
  • 用户明确要求生成项目梳理文档

不触发的场景:

  • 用户只是问某个模块怎么工作、某个接口怎么实现(这类问题直接回答,不启动完整梳理流程)
  • 用户说"理解一下代码"、"看看这个文件"(这不等于梳理项目)
Installs
1
GitHub Stars
128
First Seen
13 days ago
project-analyzer — 5zjk5/prompt-engineering