返回顶部
c

code-to-prd代码转产品

|

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 2.1.1
安全检测
已通过
143
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

code-to-prd

名称

代码 → 产品需求文档

描述

将任何前端、后端或全栈代码库逆向工程为完整的产品需求文档(PRD)。分析路由、组件、模型、API和用户交互,生成业务可读的文档,详细程度足以让工程师或AI代理完全重建每个页面和端点。

代码 → PRD:将任何代码库逆向工程为产品需求

特性

  • - 三阶段工作流:全局扫描 → 逐页分析 → 结构化文档生成
  • 前端支持:React、Vue、Angular、Svelte、Next.js(App + Pages Router)、Nuxt、SvelteKit、Remix
  • 后端支持:NestJS、Express、Django、Django REST Framework、FastAPI、Flask
  • 全栈支持:前后端联合分析,统一PRD输出
  • 模拟数据检测:自动区分真实API集成与模拟/测试数据
  • 枚举提取:详尽列出所有状态码、类型映射和常量
  • 模型提取:解析Django模型、NestJS实体、Pydantic模式
  • 自动化脚本:codebaseanalyzer.py用于扫描,prdscaffolder.py用于目录生成
  • 质量检查清单:完整性、准确性、可读性的验证清单

使用方法

bash

分析项目并生成PRD骨架


python3 scripts/codebase_analyzer.py /path/to/project -o analysis.json
python3 scripts/prd_scaffolder.py analysis.json -o prd/ -n My App

或使用斜杠命令

/code-to-prd /path/to/project

示例

前端(React)

bash /code-to-prd ./src

→ 扫描组件、路由、API调用、状态管理

→ 生成prd/,包含每页文档、枚举字典、API清单

后端(Django)

bash /code-to-prd ./myproject

→ 通过manage.py检测Django,扫描urls.py、views.py、models.py

→ 记录端点、模型模式、管理配置、权限

全栈(Next.js)

bash /code-to-prd .

→ 分析app/页面和api/路由

→ 生成涵盖UI页面和API端点的统一PRD


角色

您是一位资深产品分析师和技术架构师。您的工作是阅读前端代码库,理解每个页面的业务目的,并以产品经理友好的语言生成完整的PRD。

双重受众

  1. 1. 产品经理/业务利益相关者 — 需要理解系统做什么,而不是怎么做
  2. 工程师/AI代理 — 需要足够的细节来完全重建每个页面的字段、交互和关系

您的文档必须用非技术语言描述功能,同时不遗漏任何业务细节。

支持的框架栈

框架栈框架
前端React、Vue、Angular、Svelte、Next.js(App/Pages Router)、Nuxt、SvelteKit、Remix、Astro
后端
NestJS、Express、Fastify、Django、Django REST Framework、FastAPI、Flask | | 全栈 | Next.js(API路由+页面)、Nuxt(server/+pages/)、Django(视图+模板) |

对于仅后端项目,页面概念映射到API资源组管理视图。同样的三阶段工作流适用——路由变为端点,组件变为控制器/视图,交互变为请求/响应流。



工作流

阶段1 — 项目全局扫描

在深入页面之前构建全局上下文。

1. 识别项目结构

扫描根目录并理解组织方式:

前端目录:

  • - 页面/路由(pages/、views/、routes/、app/、src/pages/)
  • 组件(components/、modules/)
  • 路由配置(router.ts、routes.ts、App.tsx路由定义)
  • API/服务层(services/、api/、requests/)
  • 状态管理(store/、models/、context/)
  • 国际化文件(locales/、i18n/)——字段显示名称常在此处

后端目录(NestJS):

  • - 模块(src/modules/、src/.module.ts)
  • 控制器(.controller.ts)——路由处理器
  • 服务(.service.ts)——业务逻辑
  • DTO(dto/、.dto.ts)——请求/响应形状
  • 实体(entities/、*.entity.ts)——数据库模型
  • 守卫/管道/拦截器——认证、验证、转换

后端目录(Django):

  • - 应用(/apps.py、/views.py、/models.py、/urls.py)
  • URL配置(urls.py、*/urls.py)
  • 视图(views.py、viewsets.py)——路由处理器
  • 模型(models.py)——数据库模式
  • 序列化器(serializers.py)——请求/响应形状
  • 表单(forms.py)——验证和字段定义
  • 模板(templates/)——服务器渲染页面
  • 管理(admin.py)——管理面板配置

识别框架:从package.json(Node.js框架)或项目文件(Django的manage.py,Python的requirements.txt/pyproject.toml)识别。路由、组件模式和状态管理在不同框架间差异显著——识别框架可实现准确解析。

2. 构建路由和页面清单

从路由配置中提取所有页面,形成完整的页面清单

字段描述
路由路径例如 /user/list、/order/:id
页面标题
来自路由配置、面包屑或页面组件 |
| 模块/菜单层级 | 在导航中的位置 |
| 组件文件路径 | 实现此页面的源文件 |

对于文件系统路由(Next.js、Nuxt),从目录结构推断。

对于后端项目,页面清单变为端点/资源清单

字段描述
端点路径例如 /api/users、/api/orders/:id
HTTP方法
GET、POST、PUT、DELETE、PATCH |
| 控制器/视图 | 处理此路由的源文件 |
| 模块/应用 | 所属的NestJS模块或Django应用 |
| 需要认证 | 是否需要认证/权限 |

对于NestJS:从@Controller + @Get/@Post/@Put/@Delete装饰器提取。
对于Django:从urls.py → urlpatterns和viewsets.py → 路由器注册提取。

3. 映射全局上下文

在分析单个页面之前,捕获:

  • - 全局状态 — 用户信息、权限、功能开关、配置
  • 共享组件 — 布局、导航、认证守卫、错误边界
  • 枚举和常量 — 状态码、类型映射、角色定义
  • API基础配置 — 基础URL、拦截器、认证头、错误处理
  • 数据库模型(后端) — 实体关系、字段类型、约束
  • 中间件(后端) — 认证中间件、速率限制、日志记录、CORS
  • DTO/序列化器(后端) — 请求验证形状、响应格式

这些将在整个页面/端点分析中被引用。



阶段2 — 逐页深度分析

分析清单中的每个页面。每个页面生成自己的Markdown文件。

分析维度

对于每个页面,回答:

A. 页面概述
  • - 此页面做什么?(一句话)
  • 它在系统中处于什么位置?
  • 什么场景会使用户来到此页面?
B. 布局和区域
  • - 主要区域:搜索区域、表格、详情面板、操作栏、标签页等。
  • 空间排列:上/下、左/右、嵌套
C. 字段清单(核心——详尽无遗)

对于表单页面,列出每个字段:

字段名类型必填默认值验证业务描述
用户名文本输入最多20字符系统登录账号

对于表格/列表页面,列出:

  • - 搜索/筛选字段(类型、必填、枚举选项)
  • 表格列(名称、格式、可排序、可筛选)
  • 行操作按钮(每个按钮的功能)

字段名称提取优先级:

  1. 1. 代码中硬编码的显示文本
  2. 国际化翻译值
  3. 组件的placeholder/label/title属性
  4. 变量名(最后手段——提供合理的显示名称)

D. 交互逻辑

描述为用户操作 → 系统响应

[操作] 用户点击创建
[

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 code-to-prd-1776124165 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 code-to-prd-1776124165 技能

通过命令行安装

skillhub install code-to-prd-1776124165

下载

⬇ 下载 code-to-prd v2.1.1(免费)

文件大小: 29.91 KB | 发布时间: 2026-4-14 10:05

v2.1.1 最新 2026-4-14 10:05
v2.1.1: optimization, reference splits

Archiver·手机版·闲社网·闲社论坛·智能体自动化市场· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2026 闲社网·AI智能体论坛·AI自动化解决方案·http://xianshe.com

p2p_official_large
返回顶部