维护指南
这个 Wiki 按“静态站 + 源数据文件”的方式维护。适合部署到服务器,团队成员通过链接访问;项目负责人维护需求池和项目资料。
如何维护项目
1
收集
所有新需求、问题、截图和评审结论先进入需求池或项目记录。
2
评审
需求只落进入V1、进入V2、需补资料、暂缓/删除四类结论。
3
回写
评审后1个工作日内更新需求池、风险和待补资料清单。
如何维护 Wiki
同步边界:本地 Excel 或 CSV 被修改后,线上 Wiki 不会自动变化。需要先运行构建脚本刷新 Wiki 数据,再把整个
09_项目内部Wiki 目录重新部署到服务器。只有接入后端、CI/CD 或服务器定时同步任务后,才可以做到自动或半自动同步。- 更新项目源文件,例如需求池评审版 Excel、埋点 CSV、规范文档。
- 在项目根目录运行:
python3 09_项目内部Wiki/tools/build_wiki.py - 这个脚本会优先读取最新需求池评审版 Excel,刷新需求池数据、埋点数据、搜索索引、下载文件和截图索引,并检查每个 HTML 页面是否已安装百度统计代码。
- 检查
09_项目内部Wiki/index.html和pages/requirements.html。 - 将整个
09_项目内部Wiki目录部署到服务器。
部署建议:用 Nginx、宝塔、静态文件服务或对象存储都可以。部署时不要只上传 HTML,要上传整个
09_项目内部Wiki 文件夹,包括 assets、downloads、pages、img 和 tools。如何维护需求池
需求池正式主记录仍建议保留在 03_需求池 目录。Wiki 的需求池页面负责展示、筛选、浏览器本地草稿和导出,不直接替代正式源文件。
| 维护动作 | 建议方式 | 注意事项 |
|---|---|---|
| 新增需求 | 在正式 CSV/XLSX 中新增 PRD ID | ID 不要复用,字段尽量完整 |
| 修改优先级 | 评审后修改 优先级 和 决策结论 | 重大变更写入评审结论记录 |
| 补验收标准 | 更新 验收标准 字段 | 避免只写“清晰”“顺畅”这类不可测试表达 |
| 导出给团队 | 在 Wiki 需求池页导出当前筛选 CSV/Excel | 适合按业务/研发/埋点视图单独分发 |
| 多人在线编辑 | 后续可接入后端或低代码表格 | 纯静态站无法把浏览器编辑自动写回服务器 |
后续功能预留
- 接入后端接口,实现需求池多人在线编辑和权限控制。
- 增加研发任务映射,关联 PRD ID、研发任务 ID、测试状态和上线状态。
- 增加埋点验收看板,记录每个事件在测试环境和线上环境的验收结果。
- 增加版本复盘页,沉淀上线范围、指标变化和下一版建议。
