AI 时代，产品研发用的 markdown 需求文档工具

[Walt7525]

https://github.com/walt7525/waltpad

WaltPad

面向产品和研发团队的需求文档协作平台，支持 Markdown 编写、多人评审、AI 辅助和一键导出到 Confluence 。

功能特性

文档编辑

• Markdown 双栏实时预览，同步滚动
• 支持图片拖拽/粘贴插入
• 无感自动保存
• 支持版本历史与回滚

项目与权限

• 按项目组织，支持协作
• 五级角色权限：创建者/管理员/编辑者/评审员/观察者

评审流程

• 文档状态流转：草稿 → 评审中 → 已定稿
• 在预览区选中任意文字，一键创建评审待办
• 待办支持完成、驳回（附理由），并高亮定位原文

AI 助手

• 接入兼容 OpenAI 协议的任意大模型
• 支持全文模式和选中片段模式
• 流式输出，可修改文档、插入内容或直接讨论
• 可配置多套 Prompt 模板，适配不同写作场景

导出与分享

• 一键复制为富文本，图片自动内嵌，可直接粘贴到 Confluence / Wiki
• 导出 .zip （含 Markdown 源文件和图片）
• 生成只读分享链接，无需登录即可查看

技术栈

• 前端：Next.js 14 + TypeScript + Tailwind CSS
• 数据库：PostgreSQL + Prisma ORM
• 认证：NextAuth （ JWT ）
• 部署：Docker

快速开始

1. 创建 docker-compose.yml

services:
  db:                                                                                                                                      
    image: postgres:15-alpine
    restart: always                                                                                                                        
    environment:
      POSTGRES_DB: waltpad
      POSTGRES_USER: waltpad
      POSTGRES_PASSWORD: waltpad123
    volumes:
      - pgdata:/var/lib/postgresql/data                                                                                                    
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U waltpad"]                                                                                         
      interval: 5s
      timeout: 5s
      retries: 5                                                                                                                           
 
  app:                                                                                                                                     
    image: walt7525/waltpad:latest
    restart: always
    depends_on:
      db:
        condition: service_healthy
    environment:
      DATABASE_URL: "postgresql://waltpad:waltpad123@db:5432/waltpad?schema=public"
      NEXTAUTH_SECRET: "your-secret-key-here"                                                                                              
      NEXTAUTH_URL: "http://localhost:3000"
    ports:                                                                                                                                 
      - "3000:3000"
    volumes:                                                                                                                               
      - uploads:/app/uploads

volumes:
  pgdata:
  uploads:

NEXTAUTH_SECRET 可用 openssl rand -base64 32 生成随机字符串。
NEXTAUTH_URL 改为实际访问地址。

2. 启动服务

docker compose up -d

3. 登录

容器启动后访问 http://localhost:3000，使用默认管理员账号登录：

• 账号：[e-mail]
• 密码：Admin@123

登录后请及时在「设置」中修改密码。

4. 配置 AI 助手（可选）

进入「管理后台 → AI 配置」，填入兼容 OpenAI 协议的 Base URL 、API Key 和模型名称即可启用 AI 功能。

License

MIT

[hwlv]

哪有那么麻烦，直接丢个 gpt ，就会产生一个 md

[Walt7525]

@hwlv 生成没啥问题，我们实际工作，少一个符合产研测试需求的 md 管理平台。各种 wiki 的 md 管理，不满足需求，没办法了，硬写了一个