Jamie Zhang

PRODUCT DOCUMENTATION GENERATOR

ProdDoc AI

通用型软件产品说明书与操作文档生成工作台。支持提示词生成、API 自动生成、模板提取与复用、Word 导出,从真实需求到可运行产品原型的完整实践。

Next.jsTypeScriptTailwind CSSshadcn/uidocxPlaywrightAI APIlocalStorage

项目定位

Positioning

ProdDoc AI 面向产品经理、产品运营、售前顾问、实施交付人员和培训人员,帮助他们基于通用软件产品的模块信息、关键词、参考写法和模板结构,快速形成可编辑、可保存、可导出的产品文档初稿。

项目不依赖登录和数据库,文档草稿、历史记录和默认生成偏好使用浏览器 localStorage 保存,适合作为前端作品集、交互原型和轻量演示工具。

界面展示

Screenshots
01

Dashboard 首页 — 产品定位与核心能力展示

ProdDoc AI Dashboard
02

Workspace 工作台 — 文档生成核心交互

ProdDoc AI Workspace
03

Templates 模板页 — 可复用文档模板管理

ProdDoc AI Templates
04

History 历史记录 — 本地文档管理

ProdDoc AI History
05

Settings 设置页 — API 环境配置与连接测试

ProdDoc AI Settings

核心功能

Features
01

双模式文档生成

支持「提示词辅助 + API 自动生成」双模式。未配置模型服务时可继续生成提示词和 Mock 文档;配置后可通过服务端 API 自动生成正文。

02

模板提取与复用

内置多套文档模板,启用后自动影响工作台的默认文档类型、输出风格和提示词方向,实现模板驱动的文档生成。

03

服务端 API 安全

API Key 仅在服务端 API Route 中读取,前端只请求本项目的服务端接口,不会接触或展示真实密钥。

04

Word 导出

支持将生成的文档导出为 Word 格式,基于 docx 库实现,可直接用于产品交付和内部分享。

05

历史记录管理

使用 localStorage 保存文档草稿和生成记录,支持查看、搜索、筛选、复制和删除,无需登录和数据库。

06

截图辅助与预览

支持多图上传、缩略图预览,文档实时预览与编辑,所见即所得的文档生成体验。


技术实现

Technical

页面结构

/Dashboard 首页

/workspace文档生成工作台

/templates模板管理

/history历史记录

/settings环境配置

技术栈

前端框架

Next.js App RouterReactTypeScript

UI 组件

Tailwind CSSshadcn/ui

AI 能力

OpenAI-compatible API服务端 API Route

文档处理

docx 库Word 导出

测试

Playwright端到端测试