桌面产品文档PRD线上整理 交接文档

本次目标

  • 把桌面 产品文档 原型包整理成适合线上知识库阅读和继续写需求的 PRD 工作区。

已完成内容

  • 识别 /Users/ayang/Desktop/产品文档 为 Axure/原型导出的 HTML 文档包,共 69 个 HTML 页面。
  • 新增 PRD 总入口:docs/PRD/00-PRD目录.md
  • 新增换机侠运营后台产品文档索引:docs/PRD/换机侠运营后台/00-产品文档索引.md
  • 新增短路径导航入口:docs/换机侠运营后台/00-产品文档索引.md,用于兼容 https://docs.gogo996.com/换机侠运营后台/00-产品文档索引
  • 新增模块短路径入口:docs/模块/版本与变更.mddocs/模块/竞拍.md 等 6 个页面,用于兼容 /模块/... 访问。
  • 新增换机侠模块短路径入口:docs/换机侠运营后台/模块/版本与变更.mddocs/换机侠运营后台/模块/竞拍.md 等 6 个页面,用于兼容 /换机侠运营后台/模块/... 访问。
  • 按业务分组整理 6 个模块页:版本与变更、竞拍、订单与售后、运营后台、代理商、小程序。
  • 全量导入桌面产品文档:将 69 个 HTML 页面转成 Markdown,放入 docs/PRD/换机侠运营后台/原始产品文档/
  • 新增全量目录:docs/PRD/换机侠运营后台/原始产品文档/00-全量产品文档目录.md
  • 在知识库首页增加“产品需求”入口。
  • 敏感信息处理:不上传原始 HTML 包,不写入示例手机号、IMEI、订单号、密码、内部接口鉴权、密钥、Cookie。

代码位置

  • 本地路径:/Users/ayang/Projects/product-mapping
  • 原始产品文档来源:/Users/ayang/Desktop/产品文档
  • 私有 Git 仓库:github remote

运行方式

cd /Users/ayang/Projects/product-mapping
./scripts/publish-docs.sh "新增桌面产品文档 PRD 工作区"

测试结果

  • 已通过:./scripts/docs-check.sh
  • 已通过:git diff --check

部署或发布状态

  • 已提交到 GitHub private。
  • 已推送腾讯云 server 远端。
  • Quartz 构建成功,线上已验证 PRD 目录、换机侠索引和竞拍模块页面返回 200。
  • 已配置本机到腾讯云文档服务器的免密码 SSH 发布:server 远端使用 project-docs-server Host 别名。

风险和待办

  • 当前是第一版 PRD 工作区和关键模块摘要,后续正式做需求时需要逐个模块补验收标准、字段规则、接口口径和版本范围。
  • 原始 HTML 中包含部分内部文档链接和报文样例,正式开发前需要线下核对,不建议直接公开进线上知识库。

安全说明

  • 本文档不记录 API Key、密码、Cookie、私钥、真实账号令牌。
  • 免密码发布只记录 Host 别名和密钥文件路径,不记录私钥内容或服务器登录密码。