# AI智能生成产品文档 **Repository Path**: magicdroid/aidoc ## Basic Information - **Project Name**: AI智能生成产品文档 - **Description**: 一个专注于AI智能生成产品文档的开源项目，旨在通过自动化技术提高文档编写效率，构建AI时代产品研发协作新模式 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 1 - **Created**: 2026-02-19 - **Last Updated**: 2026-02-24 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # AI PRD Generator - AI 产品需求文档生成器 一个基于大语言模型的智能产品需求文档 (PRD) 生成工具。采用**两阶段架构**：先直接流式生成基础文档，再基于完整文档进行 AI 优化，实现高效、可控的 PRD 编写体验。

License Next.js React TypeScript Tailwind Vercel AI SDK

--- ## 📖 目录 - [核心特性](#-核心特性) - [快速开始](#-快速开始) - [使用指南](#-使用指南) - [项目架构](#-项目架构) - [文档](#-文档) - [开发指南](#-开发指南) --- ## ✨ 核心特性 ### 🎯 两阶段架构 | 阶段 | 功能 | 技术特点 | 耗时 | |------|------|----------|------| | **Phase 1: 直接生成** | 流式生成基础 PRD | 单轮 LLM 调用，实时流式输出 | 30-60s | | **Phase 2: 文档优化** | 基于完整文档智能优化 | 多维度优化策略（扩展、补充、一致性检查等） | 20-40s | ### 📝 生成内容 基础文档包含： - **产品概述** - 定位、价值主张、目标用户画像 - **业务流程设计** - 核心场景流程图、业务规则、状态流转 - **功能模块设计** - 功能描述、业务流程、输入输出、验收标准 - **数据模型** - 核心实体字段定义、实体关系 - **非功能需求** - 性能、安全、兼容性要求 ### 🔧 文档优化操作 支持对生成的文档进行多种优化： **全文优化**: - **内容扩展** - 深化章节内容，增加细节描述 - **流程补充** - 完善业务流程和状态转换 - **数据模型** - 补充或完善数据结构设计 - **一致性检查** - 检查并修正文档内部不一致 - **改进建议** - 提供产品方案优化建议 - **API 设计** - 补充接口设计文档 **局部优化** (选中段落): - 在编辑器中选中文本，显示浮动优化菜单 - 支持内容扩展、补充流程、补充异常、润色表达等 - 章节感知上下文，保持与前后文的逻辑一致性 - 支持差异对比（Diff），确认后应用或取消 **AI 智能审查**: - **章节化审查**：基于具体章节（如用户画像、业务流程）的职责进行定向挑错，避免职责错位。 - **多功能建议展示**：按类别（完整性、深度、一致性等）和严重程度进行过滤与直观展示。 - **双模智能采纳**：支持针对特定错误片段的**覆盖替换**与**无损追加(+)**模式，防止原格式（如列表、换行）坍塌。 - **纯净文本编辑**：自动剥离大模型回复中的多余说明，支持最终合入文本的二次编辑。 - **应用状态保留**：将已采纳与忽略的状态持久化存储在服务端，保障各终端视图一致，便于多人协作。 **自定义 AI 技能**: - **自然语言定制** - 仅需用大白话描述需要 AI 做的事情，系统专属的 Prompt 引擎会自动提炼为专业系统指令。 - **专属面板管理** - 随时创建、调用属于自己的沉淀分析技能（如：“空状态异常漏检大师”等）。 - **统一数据管道** - 定制的技能所生成的结果，完全兼容内置核心基准输出结构，汇入并呈现于待办清单供一键操作。 ### 🎨 编辑器特性 - **分屏 Markdown 编辑器** - 左编右实时预览 - **三种显示模式** - 编辑/分屏/预览自由切换 - **智能审查面板** - 浮动右侧面板直通文档全局诊断与采纳 - **局部浮动菜单** - 选中文本后悬浮快捷指令集 - **Diff 对比与双模替换** - 提供精细的格式继承与对比采纳机制 - **全屏聚焦** - 沉浸式写作体验 - **持久化保存** - 历史记录与 AI 审查结果状态的服务端持久化 ### 🛠️ 其他特性 - **多模型支持** - DeepSeek (推荐)、OpenAI、智谱 GLM - **请求日志** - 完整的 AI 请求记录，便于调试 - **流式响应** - 实时查看生成进度 - **隐私安全** - API Key 仅服务端配置 --- ## 🚀 快速开始 ### 环境要求 - Node.js 18+ - npm 9+ 或 pnpm 8+ ### 安装步骤 ```bash # 1. 克隆项目 git clone https://github.com/your-username/ai-prd-generator.git cd ai-prd-generator # 2. 安装依赖 npm install # 3. 配置环境变量 cp .env.example .env.local # 编辑 .env.local，填入你的 API Key # 4. 运行开发服务器 npm run dev ``` 打开浏览器访问 [http://localhost:3000](http://localhost:3000) ### 环境变量配置 在项目根目录创建 `.env.local` 文件： ```env # DeepSeek (推荐，性价比高) DEEPSEEK_API_KEY=sk-xxxxxxxxxxxxxxxxxxxx # OpenAI (可选) OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxx # 智谱 GLM (可选) GLM_API_KEY=xxxxxxxxxxxxxxxxxxxx ``` --- ## 📚 使用指南 ### 生成基础文档 1. 在首页输入产品想法，例如： ``` 做一个宠物交友APP叫宠遇，面向25-35岁养宠物的都市白领， 解决宠物社交和寻找配种伙伴的需求。 核心功能：宠物档案、附近宠物发现、配种匹配、宠物日记分享 ``` 2. 点击"生成基础文档"按钮 3. 等待流式生成完成（约 30-60 秒） 4. 在分屏编辑器中查看结果，左侧可编辑 Markdown，右侧实时预览 ### 优化文档 **全文优化**： 1. 点击"优化文档"按钮 2. 选择优化类型（扩展内容、补充流程、数据模型等） 3. 可选：输入具体优化指令 4. 等待 AI 完成优化 **局部优化**（选中文本）： 1. 在编辑器中选中需要优化的段落 2. 浮动菜单显示优化选项 3. 选择优化类型： - **内容扩展** - 深化描述，增加细节 - **补充流程** - 完善业务流程 - **数据模型** - 补充数据结构 - **异常处理** - 补充边界情况 - **自定义** - 输入具体优化指令 4. 查看 Diff 对比，确认后应用或取消 > 局部优化会自动分析前后章节上下文，保持文档逻辑一致性。AI 会标注推测内容和冲突点。 ### 查看历史记录 - 点击导航栏"历史记录"查看所有文档 - 点击文档标题进入详情页继续编辑 - 支持修改原始需求和文档内容 ### 查看请求日志 - 点击导航栏"系统日志"查看所有 AI 请求记录 - 用于调试和了解 AI 实际执行情况 --- ## 🏗️ 项目架构 ### 技术栈 | 层级 | 技术 | 说明 | |------|------|------| | **前端框架** | Next.js 14 + React 18 | App Router, Server Components | | **编程语言** | TypeScript 5 | 严格类型检查 | | **样式方案** | Tailwind CSS 3.4 | 原子化 CSS | | **UI 组件** | Lucide React | 图标库 | | **编辑器** | 分屏 Markdown 编辑器 | 基于 textarea + ReactMarkdown，支持局部优化 | | **AI SDK** | Vercel AI SDK 6.0 | 流式生成、多模型支持 | | **存储** | 本地文件系统 | JSON + Markdown | ### 目录结构 ``` ai-prd-generator/ ├── app/ # Next.js App Router │ ├── api/ # API 路由 │ │ ├── generate-simple/ # 基础文档生成（流式） │ │ ├── optimize-section/ # 局部段落优化 │ │ ├── logs/ # 请求日志查询 │ │ ├── history/ # 历史记录 CRUD │ │ └── models/ # 模型配置接口 │ ├── generate/ # 生成页面 │ ├── history/ # 历史记录页面 │ ├── logs/ # 系统日志页面 │ ├── layout.tsx # 根布局 │ └── page.tsx # 首页 ├── components/ # React 组件 │ ├── ui/ # UI 组件（Navbar 等） │ └── editor/ # 编辑器组件 │ ├── MarkdownSplitEditor.tsx # 分屏 Markdown 编辑器 │ ├── SimpleEditor.tsx # 简单编辑器 │ └── TiptapEditor.tsx # Tiptap 编辑器（备用） ├── lib/ # 工具库 │ ├── agents/ # AI Agent 模块 │ │ ├── StreamingPRDGenerator.ts # 流式基础生成器 │ │ ├── DocumentOptimizer.ts # 文档优化器 │ │ └── ... # 其他生成器 │ ├── logger/ # 日志模块 │ │ └── RequestLogger.ts # 请求日志记录 │ ├── ai-config.ts # AI 模型配置 │ └── models.ts # 模型定义 ├── data/ # 数据存储 │ ├── records/ # 生成的 PRD 文档 (JSON) │ └── logs/ # 请求日志 (JSONL) └── docs/ # 项目文档 ``` ### 核心流程 ``` 用户输入 → 直接流式生成 → 基础 PRD 文档 → AI 优化 → 最终文档 ↓ 实时流式展示 ↓ 自动保存历史 ``` --- ## 📖 文档 | 文档 | 说明 | 目标读者 | |------|------|----------| | [docs/architecture.md](./docs/architecture.md) | 技术架构详解 | 开发者 | | [docs/api-reference.md](./docs/api-reference.md) | API 接口文档 | 开发者 | | [docs/user-guide.md](./docs/user-guide.md) | 用户操作指南 | 最终用户 | | [docs/development-log.md](./docs/development_log.md) | 开发日志与决策记录 | 维护者 | --- ## 🔧 开发指南 ### 安装依赖 ```bash npm install ``` ### 开发模式 ```bash npm run dev ``` ### 构建生产版本 ```bash npm run build npm start ``` ### 代码规范 - 使用 TypeScript 严格模式 - 组件使用函数式编程 + Hooks - API 路由添加适当的错误处理 - 新功能需补充文档 --- ## 📝 许可证 本项目采用 [MIT](LICENSE) 许可证。 ---

Made with ❤️ by AI PRD Generator Team