文档与版本怎样维护
文档站增加一条连续阅读路线:先看产品、选平台、采用、完成首单,再查配置和证据。原 Skill、平台完整包、验收原件、PDF 和视频保留各自的来源与用途。 建站不要求重新打包或重新上传已发布资产。
各处负责什么
| 位置 | 负责的内容 | 更新原则 |
|---|---|---|
| 仓库 README | 项目入口、核心价值、下载与文档链接 | 保持简短,指向统一文档站 |
| 文档站导览 | 用户的选择、采用顺序和常见问题 | 根据当前公开版本修订,不另造测试结论 |
| 文档站参考页 | 现有配置清单、平台原始说明、基础 Skills | 从仓库原文生成;改来源,不手工维护第二份正文 |
| GitHub Release | 已发布 ZIP 等下载资产 | 文档链接复用现有资产;产品更新才另走版本发布 |
| 历史验收与版本记录 | 当时的文件、动作、结果和边界 | 保留原件;新结果追加,不改写旧成绩 |
一次文档更新的检查顺序
- 先看当前远端与已有改动。 确认正在修改哪个版本,避免覆盖他人的更新。
- 只改需要改变的来源。 导览调整不触碰平台原生载荷;正文修订在原文件完成,再生成参考页。
- 检查阅读路线。 新用户能从选平台一直走到拿到成果;ZIP 类型、作用范围与更新方法说清楚。
- 检查站点与原件。 链接、搜索、手机阅读和构建要可用;旧下载地址可达,已发布文件指纹保持原值。
- 分别记录文档变更与产品变更。 导航改善不是业务重测;新平台载荷也不能借旧证据直接宣称通过。
公开内容的边界
只引用仓库中已公开的材料。内部台账、私人聊天、账号资料、私人头像、凭据和未脱敏测试回件不进入文档站。第三方平台名称、账号及软件的权利不因本项目许可而转移,具体按仓库 LICENSE 与 NOTICE 执行。