文档阅读与本地发布包¶
1. 概述¶
落实已批准路线图的文档站,以及 Git 维护规范第 6 节的文档构建与发布基线。用户本轮确认“先完成本地站点与发布包”。本轮不远程创建仓库、发布网站、变更域名或读取旧仓库,不开展实验业务。
2. 需求¶
US1:阅读正式文档(P1)¶
读者能从首页找到规范、技术决策和操作指南,阅读目录与代码示例,下载接口说明。Why this priority:已有平台需要可用的阅读入口。Independent Test:不启动业务应用,也能打开首页、规范和指南。
US2:获得可复核的发布包(P2)¶
维护者能重复生成相同范围的静态文件,并明确哪些材料没有发布。Why this priority:后续远端发布沿用同一产物。Independent Test:解包到独立目录阅读,包内不存在凭据、草稿、第三方文章或过程日志。
| 编号 | 功能需求 |
|---|---|
| FR-001 | 首页区分正式规范、技术决策与操作指南,保留现有文档来源 |
| FR-002 | 阅读时提供导航、页内目录与已有标题检索,不扩展平台业务 |
| FR-003 | 发布清单仅包含正式规范、技术决策、阅读指南和明确允许的接口附件 |
| FR-004 | 未发布材料的引用明确标注为本地资料,不产生虚假可点击入口;原文档保持唯一来源 |
| FR-005 | 本地站点独立运行,不读取账户信息,不依赖业务服务或数据库 |
| FR-006 | 发布包包含完整静态内容、内容范围清单和文件校验值,保留子路径访问能力 |
| FR-007 | 准备仅默认分支执行发布、其他变更只验证的发布配置;未执行远端发布时明确标记 |
3. 验收标准¶
| 编号 | 可观察结果 |
|---|---|
| SC-001 | 首页的规范、决策、指南三个入口均可打开,至少阅读各 1 页 |
| SC-002 | 用 1 个完整标题检索返回至少 1 条结果,点击可阅读 |
| SC-003 | 发布清单中凭据、草稿、第三方文章和过程日志数量均为 0 |
| SC-004 | 静态内容的本地链接及资源失效数为 0;未发布引用均显示本地资料说明 |
| SC-005 | 站点在业务服务不参与的情况下可独立预览;阅读不触发业务接口请求 |
| SC-006 | 同一来源连续构建 2 次,正文来源清单一致;压缩包解包后全部文件校验通过 |
| SC-007 | 首页和深层文档在根路径与至少 1 个子路径均可阅读,资源加载正常 |
| SC-008 | 发布配置、输入条件和未验证的远端条件写明,不以本地成功宣称远端成功 |
Edge Cases:来源不存在、发布清单越界、失效链接和构建错误必须失败;不得退回展示旧产物冒充新产物。没有远端凭据时交付本地包及配置。
4. 假设与设计¶
读者在本地阅读站点。正式文档原路径不移动;站点从受控来源生成。由首页进入分类、打开文档或检索标题;涉及未发布资料时展示说明,不跳转到不存在的内容。
5. 提交前自查¶
本规格只细化既有文档站交付,不修改宪法范围和应用权限。技术配置、来源映射与构建路径由 docs-site-001 技术包承接。