Zc Release Documentation Sync

发布后文档同步

zmice 170f907 2.4 KB Updated

File contents

发布后文档同步

何时使用

  • 版本、功能或配置已经发布,需要确认长期文档没有落后于真实状态时
  • 发布说明已经写完,但还需要逐项核对 README、安装说明和行为变更记录时
  • 发布后发现用户或内部同事仍按旧路径操作,需要做 drift closure 时

输入前提

  • 代码和发布动作已经完成,当前重点是收尾而不是重新设计方案
  • 已知本次发布影响了哪些入口、配置、默认行为或升级路径
  • 相关 owner 能立即修正文档,而不是把问题留到下个版本

执行步骤

  1. 列出本次发布影响的同步对象,只保留长期会被消费的文档:
    • README、quick start、首次成功路径
    • 安装、升级、回滚或迁移说明
    • 公共 API、CLI、配置项、默认值说明
    • 用户可见行为变更、兼容性边界、已知限制
  2. 逐项核对这些文档是否反映真实发布状态,而不是反映开发中间态
  3. 对缺失项立即补齐,或明确记录 owner、截止时间和阻断原因
  4. 用最小验收确认收尾完成:
    • 新用户能按文档走通最小成功路径
    • 旧用户知道是否需要升级、迁移或回滚动作
    • 支持、运维和后续开发不会因为旧文档误判
  5. 记录仍然存在的差异;如果差异会误导用户或运维,就把它视为未完成收尾

成功标准

  • 发布后的长期文档与真实状态一致
  • 文档同步对象清晰,没有把临时说明误当成长期文档
  • 影响安装、升级、回滚或默认行为的变化都有明确说明
  • drift 没有带入下一个版本

边界

  • 本 skill 只负责发布后的文档同步和 drift closure
  • 不替代 documentation-and-adrs 的决策记录、ADR 和长期知识沉淀
  • 不替代 shipping-and-launch 的发布 gate、灰度、监控和回滚策略
  • 不扩展成通用文档大全;只处理本次发布真正受影响的长期文档

最小清单

  • README / quick start 已同步
  • 安装、升级、回滚说明已同步
  • 行为变更、默认值变化、兼容性边界已同步
  • 如有剩余差异,已明确 owner 和关闭时间

与其他技能的衔接

  • 发布前通常先用 shipping-and-launch
  • 需要判断应该记录什么、哪些文档已 drift 时,回到 documentation-and-adrs

zmice/zc-qwen-extension/tree/main/skills/zc-release-documentation-sync commit 170f907c7d

Frequently asked questions

npx skillmds@latest add zmice/zc-release-documentation-sync