
文档发布专家:常见问题
Written By

技能练习生
不管你是一个开源项目的核心维护者,还是在一个快节奏的公司内部由小团队合作,这些关于 "/document-release" 的高频疑问或许也是你关心的。
它会把我的 README 整个重新写一遍吗?
不会。文档发布专家非常“克制”。它只会在通过 git diff 观察到某些代码变更(比如新增了一个参数、改了一个 API 路径、或者 package.json 版本的变化)后,精准地去定位并更新 README、CONTRIBUTING 或 ARCHITECTURE 里受影响的那一两行。它像一个打补丁的顶尖裁缝,绝不会直接把你的旧衣服扔掉换件新。
CHANGELOG 里的文字润色,万一改得词不达意怎么办?
它内置了“语义理解”模块,会首先完整阅读你的 commit message(即使写得比较碎)。如果它对某次改动的意图拿不准,它会通过交互式问答(比如 A/B/C 三选一)来向你确认。你可以选择接受它的润色建议,也可以选择原汁原味地保留自己的 commit,或者在这个基础上再稍微调整一下。
我一定要在发起 PR 之后才能运行它吗?
建议你在准备合并 PR 之前,或者刚发起 PR 的时候运行。它能帮你完成最后一步“文档对齐”。其实在任何功能分支上,只要你提交了至少一个 commit,它就能嗅到变动并开始工作。运行完之后,它甚至能自动帮你把本地代码推送到远程分支,并同步更新你在 GitHub 上的 PR 描述,让文档始终跑在代码前面。
每次运行它都会自动升级版本号吗?
不会。版本号升级(VERSION)是一个非常严肃的决策。它只会在检测到你可能需要升级时跳出一个明确的选择菜单给你。你可以选择升级一个 patch(补丁版)、升级一个 minor(功能增强版),或者干脆跳过不升。只有当你点下确认键以后,它才会真的去动你的 VERSION 文件。