Docs 实施计划
维护架构、需求、API 说明、设计索引、运行说明、实施计划、进度和历史八类内容
归档内容,只读,不代表现行方案。现行文档见文档总览。
目标与范围
维护架构、需求、API 说明、设计索引、运行说明、实施计划、进度和历史八类内容。实施计划为各模块提供唯一可执行入口,需求和执行结果保持各自权威位置。
需求输入与确认
依据文档归属规则维护总计划、15 个模块计划及跨仓联调。需求引用产品页、字段引用 API/Contracts、状态引用进度;不把讨论过程和重复优先级段落追加到所有页面。
设计与原型
以“下一步总顺序”“一个模块从需求到上线怎么做”“一个跨仓场景怎样验收”三种查找任务走查导航。模块沿用稳定 URL;必要迁移使用直达新页的重定向,历史正文不混入当前搜索。
API 与文档交付
消费 Contracts 规范并导出文档资源,校验原文件一致性;站内搜索、目录、AI 汇总与 sitemap 反映现行栏目。Docs 不实现客户 API;接口规范已生成不代表业务运行通过。
实施步骤与交付物
| 步骤 | 实施内容 | 交付物与退出条件 |
|---|---|---|
| DOC-01 内容盘点 | 清点现行/重复/过时内容与引用位置 | 迁移表、修改前快照和归属清单 |
| DOC-02 计划组织 | 总计划、模块完整计划、联调与管理规则分别归位 | 15 个模块均有范围、设计、API、步骤、依赖、验收和待定项 |
| DOC-03 链接与规范 | 更新导航/当前链接,保留旧地址,核对 API 导出 | 无断链、无重复入口,规范内容一致 |
| DOC-04 内容校验 | 走查待定/已确认/已实现表达,检查历史隔离与检索 | 不把上游源码或旧完成状态当新服务验收 |
| DOC-05 构建交接 | 文档检查、构建、本机预览与访问验证 | 可访问新目录,证据与维护规则登记工作台 |
依赖与接入顺序
各模块内容随需求/实现变化更新;Contracts 提供规范源,Design 提供品牌源。生产发布与本机预览分别记录。
验收标准
- 每模块只有一个主计划,内含可执行步骤与模块特定验收。
- 当前导航和正文无失效链接,旧地址正确跳转;历史内容保持可追溯。
- docs:check、构建、预览及规范一致性检查通过;完成声明有证据来源。
待定项与后续范围
正式文档发布域名、更新责任与对外公开范围按发布安排确认;当前重构不改变产品需求或架构决定。
本文定义计划,不累积执行日志。实际版本、完成状态和验证证据见项目进度;任务状态登记到本机工作台,并关联本文步骤。