该技能是一个文档版本策略助手,帮助团队决定开发者文档如何跟踪多个产品、库或 API 版本。它不直接生成文档,而是输出一套可执行的版本策略,包括版本状态表、URL 结构、回移植规则和读者导航方案。
主要能力:
- 通过访谈收集产品形态、支持版本表、文档现状、构建方式和维护容量等信息,缺失项标记为 ASSUMED。
- 根据产品支持表推导文档状态,而不是凭偏好决定。文档窗口可以宽于支持窗口,但不应窄于支持窗口而让受支持用户无文档可依。
- 只为不同版本间存在差异的内容建立版本;教程、未变化的概念、变更日志和博客保持单一版本。
- 在增加版本前评估每个活跃版本的维护成本,包括回移植、构建和迁移工作量。
- 提供版本退役流程:冻结、横幅提示、重定向,最后删除。
- 给出多种拓扑方案(如仅最新版加版本标记、累积徽章、按主版本冻结站点、选择器多版本站点),并按效率、读者价值、维护成本和持久性进行排序推荐。
- 定义源布局和发布切分方式,如按分支或标签构建、单分支内版本文件夹、托管文档平台等。
- 制定回移植规则并估算每月维护工时,区分当前版本与维护版本的回移植条件。
- 规划读者导航:默认落地当前版本、切换器保持同一页面、非当前版本横幅、搜索范围限定当前版本等。
使用方式:技能以访谈形式逐步提问,每次一个问题,尽量多选。用户回答后,技能会重新排序拓扑方案,并在用户确认后进入下一步。没有用户确认时,选择项标记为 ASSUMED 并在交付物顶部列出。最终交付物包含文档版本策略表、回移植规则、退役触发条件和所选拓扑。
适用场景:适用于需要管理多个版本文档的开发者关系、文档或平台团队,尤其是库或 SDK、自托管服务器、CLI、托管 API 等产品。也适用于考虑文档平台迁移或主版本发布前的规划。
限制:该技能不直接编写文档内容,不生成 canonical 标签(交由 docs-seo 技能处理),也不替代具体的文档构建工具。部分建议基于特定项目的先例(如 Kubernetes、React、Python、Django、PostgreSQL、pandas 等),实际应用时需结合自身情况调整。资料中未提供具体的收费、价格或平台支持信息。