要验证版本号格式,还是判断升级幅度?
SemVer 校验仅检查语法。兼容性和版本升级幅度应依据实际变更判断;涉及接口契约时先使用 API 版本审查工作流。
Elysia Tools
导航
Workflow Playbook
对照变更记录审核单个版本,检查版本号语法和 Markdown 引用,再生成内容一致的网站、Slack 公告与 PDF 发布说明。
专题
这个工作流面向需要把单次软件发布交给文档审核人和公告负责人的维护者。输入应是权威变更记录与明确的版本号,而不是未经筛选的提交消息。提取版本章节后,核对日期、分类及已批准变更证据。提取结果为空可能是输入格式未被识别,不能据此认定本次没有变更。尤其不要把“尚未发布”章节里的全部内容顺手放进正式公告。
主稿应说明改了什么、谁需要采取行动,以及已经批准的迁移或回退指引。版本号语法合法并不能证明本次应该升级次版本,兼容性判断应在发布前完成。格式检查用于定位可操作的问题,安全自动修正并不能代替对标题层级、代码示例及遗漏解释的人工审核。确定源稿修订号后再制作副本,避免网站、聊天公告与 PDF 在并行编辑中逐渐分叉。
简短发布说明通常不需要目录。长文先定稿标题,再生成目录,随后检查引用。工具生成的锚点遵循 GitHub 风格,仍需在实际网站渲染器中确认能否跳转。链接检查属于静态检查,不能证明软件下载地址可达;必要的外部页面应单独打开验证,包括需要登录的链接。
只生成实际需要的 HTML 和 Slack 版本。宽表格更适合留在完整说明中,聊天公告可以改为短列表,但不能省略迁移提醒和正式发布说明链接。对于不支持的表格、任务列表或依赖图片才能理解的说明,要人工改写并复核,而不是忽略转换警告。格式转换不等于部署网站,也不等于已经发送消息。
需要审核或存档时再导出 PDF,查看真实页面是否存在表格裁切、代码溢出、分页后上下文丢失。逐份比对版本号、日期、关键操作和链接。如果某个渠道仍是旧草稿,应从主稿重新生成,不要只修改那个输出文件。把批准修订号与产物名称一起留档。更大范围的手册整理使用文档编写工作流,零散格式处理使用 Markdown 工具专题;接口兼容性尚未定论时,先完成 API 版本审查再签署发布说明。
工作流指南
提取版本与分类变更,选定本次发布范围,对照批准证据核查,校验版本号字符串,但不将语法正确当作兼容性证明。
修正格式检查结果,人工检查标题与代码块,补齐用户需要了解的变更解释及迁移说明,再进行转换。
仅在有必要时生成目录,随后检查内部锚点、链接格式和未定义引用,外部网址及渲染器特有锚点另行实测。
将已批准的主稿转换为 HTML,将选定的公告转换为 Slack mrkdwn,处理不支持的元素并比对关键事实,交付文件而非自动发布。
使用适当主题导出 PDF,检查分页和可读性,再把需要交付的各份产物与同一已批准修订版本逐项核对。
SemVer 校验仅检查语法。兼容性和版本升级幅度应依据实际变更判断;涉及接口契约时先使用 API 版本审查工作流。
简短公告可以不加目录。长文先定稿标题,再生成导航,并在目标渲染器中核对锚点。
网站或 PDF 保留详细上下文;Slack 可以精简,但必须保留迁移警告及正式链接,不支持的表格与任务列表需要明确改写。