PRD生成工具

一款Claude桌面扩展工具,能够一键从README文件生成产品需求文档(PRD),适用于快速创建结构化技术文档的场景。

  • by Njengah
  • JavaScript
  • 本地部署
  • 9 星标
  • 更新于
在 GitHub 查看 Njengah/prd-dxt

使用说明

PRD生成器-克劳德桌面扩展

一个简单的Claude桌面扩展(DXT),只需单击一下即可从README文件生成产品需求文档(PRD)。

特性

  • 一键安装 -没有复杂的设置或配置文件
  • 自动PRD生成 来自README文件
  • 文件系统访问 -从任何路径读取README文件
  • 节省时间的文档 -在几秒钟内生成结构化PRD
  • 与跨平台支持 -适用于Windows、Mac和Linux

此扩展功能是什么

此扩展提供了一个简单的工具:

  1. 读取项目的README文件
  2. 从内容中提取关键信息
  3. 生成结构化的产品需求文档
  4. 为您节省文档任务的时间

先决条件

  • 克劳德桌面 (支持DXT的最新版本)
  • Node.js (与Claude Desktop捆绑在一起)
  • DXT工具链: npm install -g @anthropic-ai/dxt

安装

选项1:安装预构建扩展

  1. 下载最新 prd-generator.dxt 发布中的文件
  2. 打开克劳德桌面
  3. 首选 设置>扩展
  4. 拖动 .dxt 文件到窗口中或单击“上传”
  5. 点击“安装”
  6. 完成!

选项2:从源代码构建

# Clone the repository
git clone https://github.com/yourusername/prd-generator-dxt.git
cd prd-generator-dxt

# Install dependencies
npm install

# Test the server
npm start

# Package the extension
npx @anthropic-ai/dxt pack

🛠️ 用法

安装后,您可以在Claude Desktop中使用扩展:

Generate a PRD from my README at /path/to/your/readme.md

延期将:

  • 阅读README文件
  • 提取前5行作为项目描述
  • 生成一个结构化的PRD,其中包含以下部分:
    • 项目概述
    • 描述
    • 主要特点
    • 技术要求
    • 生成时间戳

项目结构

prd-generator/
├── server/
│   └── index.js          # Main MCP server code
├── manifest.json         # Extension configuration
├── package.json         # Node.js dependencies
├── package-lock.json    # Dependency lock file
└── README.md           # This file

🔧 发展

本地运行

# Start the MCP server
npm start

# Or run directly
node server/index.js

构建扩展

# Package into .dxt file
npx @anthropic-ai/dxt pack

测试

  1. 确保您的服务器运行时没有错误
  2. 使用示例README文件进行测试
  3. 验证生成的PRD格式

生成的PRD格式

该扩展生成具有以下结构的PRD:

# Product Requirements Document

## Project Overview
Based on: [README file path]

## Description
[First 5 lines from README]

## Key Features
- Feature extraction from README
- Automated PRD generation
- Time-saving documentation

## Technical Requirements
- Node.js runtime
- File system access
- README file parsing

Generated on: [ISO timestamp]

贡献

  1. 分叉存储库
  2. 创建要素分支: git checkout -b feature/amazing-feature
  3. 提交您的更改: git commit -m 'Add amazing feature'
  4. 推到分支: git push origin feature/amazing-feature
  5. 打开拉取请求

Todo/未来增强功能

  • []支持多种README格式(rst、txt等)
  • []可定制的PRD模板
  • []与项目管理工具集成
  • []高级内容提取和分析
  • []支持配置文件(package.json等)

🐛 已知问题

  • 路径处理可能因操作系统而异
  • 大型README文件可能会导致性能问题
  • 目前仅支持UTF-8编码的文件

📚 资源

📄 许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

备注:这是演示Claude桌面扩展的基本实现。对于生产使用,考虑添加错误处理、输入验证和更复杂的README解析。

🚀 快速开始

  1. 安装克劳德桌面 (最新版本)
  2. 下载 这 .dxt 文件
  3. 安装 通过设置>扩展
  4. 测试 with:“根据/path/to/README.md上的README生成PRD”