项目流程汇总
快速使用
- 收集项目结构与关键入口:使用
scripts/summarize_project.py,输入项目路径。 - 识别页面/路由、API、数据模型:保持“静态分析 + 约定推断”策略。
- 生成 Markdown:使用
references/output-template.md的结构输出。 - 在不确定处标注“推测/需确认”,避免过度臆断。
执行步骤
- 运行脚本:
- python skills/project-flow-summarizer/scripts/summarize_project.py <path> --out <output.md>
- 如识别框架不清晰:
- 退化为结构树 + 关键文件摘要 + 待确认清单
- 需要更详细的规则时:
- 读取 references/rules.md
- 需要输出格式细节时:
- 读取 references/output-template.md
输出要求
- 全中文
- 包含“业务流程/用户路径”文字描述(基于静态证据,需标注推测)
- 明确入口、页面/功能、API、数据模型
- 增加“风险与不确定性”章节
适配范围
- 前端:Next.js、React、Vue
- 后端:Python(FastAPI / Flask / Django)
- 数据模型:Prisma、SQLAlchemy、Pydantic、Django ORM、Mongoose
注意事项
- 不执行代码,仅做静态分析
- 避免读取超大文件(默认单文件最大 200KB)
- 跳过
node_modules、dist、build、.next、__pycache__等目录