
文档发布专家:快速入门
Written By

技能练习生
如果你刚刚完成代码提交,正在思考“我是不是忘了更新 README”或者“这次该怎么写版本更新说明”,现在就可以试试这个 Skill。它不仅能帮你把繁杂的文档修改任务一键搞定,还能给你的项目 PR 披上一层更专业、更清晰的说明文档。
第一次尝试
想象一下,你刚在一个功能分支上提交了几个 commit,并且准备把它们合入主分支。与其手动打开每一个 Markdown 文件去核对改动,不如直接给出一个简单的指令。
试试这样一个对话
"/document-release"
就这么简单。
接下来会发生什么
- 自动对齐基准:它会帮你找到当前分支和主分支(main)之间的差异点。
- 深度文档审计:它会一字不漏地读取 README.md、ARCHITECTURE.md、CHANGELOG.md 甚至是项目的 TODOS.md。
- 静默修剪:对于那些显而易见的变动——比如你新增了一个 API 却没在 README 里列出来,或是修改了一个命令行工具的参数——它会直接帮你补齐,不需要你费心。
- 语气润色:它会把那些干巴巴的 commit 记录翻译成用户能听懂的好功能。
- PR 同步:最后,它甚至会帮你把这次发布的改动点同步更新到 GitHub/GitLab 的 PR 描述里。
使用前提
只要你已经安装了 gstack 并且有权访问你的项目仓库,你就可以在任何功能分支上运行它。对于已经提交但还没合并的 PR 来说,它是最佳的最后一步“文档审计”工具。
为什么要先用它
在合并代码前,确保文档是完全同步的。如果你选择了这个 Skill,你其实是选择了一个全能的发布助手,让你的每一次发布都能像大厂一样严谨且有格调。