代码转产品需求文档 (PRD)

code-to-prd
分类编程
作者Alireza Rezvani
许可MIT
评分4.20/5
使用3.0K

/code-to-prd

将前端代码库反向工程为一份完整的产品需求文档 (PRD)。

用法

bash
/code-to-prd                    # 分析当前项目
/code-to-prd ./src              # 分析指定目录
/code-to-prd /path/to/project   # 分析外部项目

功能流程

1. 扫描 (Scan) — 运行 codebase_analyzer.py 以检测框架、路由、API、枚举和项目结构。
2. 搭建 (Scaffold) — 运行 prd_scaffolder.py 创建 prd/ 目录，包含 README.md、各页面存根 (stubs) 和附录文件。
3. 分析 (Analyze) — 按照 Phase 2 工作流遍历每个页面：分析字段、交互、API 依赖和页面关系。
4. 生成 (Generate) — 生成最终 PRD，包含所有页面详情、枚举字典、API 清单和页面关系图。

执行步骤

第一步：分析

确定项目路径（默认为当前目录）。运行前端分析器：

bash
python3 {skill_path}/scripts/codebase_analyzer.py {project_path} -o .code-to-prd-analysis.json

展示分析结果摘要：框架、页面数量、API 数量、枚举数量。

第二步：搭建

生成 PRD 目录骨架：

bash
python3 {skill_path}/scripts/prd_scaffolder.py .code-to-prd-analysis.json -o prd/

第三步：填充

针对清单中的每个页面，遵循 SKILL.md Phase 2 工作流：

  • 阅读页面的组件文件

  • 记录字段、交互、API 依赖、页面关系

  • 填充对应的 prd/pages/ 存根文件

对于大型项目（>15 个页面），建议每 3-5 个页面为一组进行处理，每组完成后请用户确认。

第四步：定稿

完成附录文件：

  • prd/appendix/enum-dictionary.md — 所有发现的枚举和状态码

  • prd/appendix/api-inventory.md — 统一的 API 参考清单

  • prd/appendix/page-relationships.md — 导航和数据耦合图

清理临时分析文件：

bash
rm .code-to-prd-analysis.json

输出结果

一个 prd/ 目录，包含：

  • README.md — 系统概览、模块图、页面清单

  • pages/*.md — 每个页面一个文件，包含字段、交互和 API

  • appendix/*.md — 枚举字典、API 清单、页面关系图

相关参考

  • product-team/code-to-prd/skills/code-to-prd/SKILL.md
  • product-team/code-to-prd/skills/code-to-prd/scripts/codebase_analyzer.py
  • product-team/code-to-prd/skills/code-to-prd/scripts/prd_scaffolder.py
  • product-team/code-to-prd/skills/code-to-prd/references/prd-quality-checklist.md