家人们,谁懂啊?写代码只要逻辑通了就行,但写文档真的是太折磨人了!😭 格式要统一、语气要专业、标点符号还不能错,稍微不注意就被 Team Leader 打回重写。特别是面对一堆 `.md` 文件的时候,简直想原地离职。
但是!最近我发现了一个超级宝藏的智能体——docs-writer。这个 Skill 简直是技术写作的救星,专门用来拯救像我这种“文档困难户”。如果你正在维护 Gemini CLI 项目,或者对技术文档规范有极高要求,那这个 Skill 绝对能让你大呼“真香”!它不仅仅是帮你写字,更是一个严谨的 AI 技术编辑。
核心功能
docs-writer Skills 的核心能力完全是为了解决“怎么写出专业技术文档”这个痛点而生的。它不是随便生成点文字,而是严格遵循 Phase 1 到 Phase 4 的标准化流程:
- 严格的风格把控:它会自动使用“你(You)”的视角,保持主动语态和现在时。这货甚至知道要避免使用拉丁缩写(比如它会把 e.g. 改成 for example),并且坚决不用俚语,生成的文档那叫一个地道且专业。
- 格式强迫症福音:自动处理 80 字符换行、标题大小写规范、UI 元素加粗等细节。它还会盯着你的标点符号,确保逗号和句号都在引号里面,简直比处女座还处女座。
- 流程化作业:从调查代码库现状、审核现有文档,到制定写作计划、执行写入,最后自我验证。这一套组合拳下来,保证文档不仅好读,而且准确无误。
实操代码示例
想看看这个神仙 Skill 怎么工作吗?当你需要为一个新功能编写文档时,只需要给它一个简单的指令,它就会根据内置的 Skills 逻辑开始运作。以下是一个典型的交互 Prompt 示例:
User: 请帮我为新的 'login' 命令编写文档,该命令位于 /packages/auth 目录下。
docs-writer:
1. **Investigate**: Checking /packages/auth for implementation details...
2. **Plan**: I will create a new file docs/login.md strictly following the Gemini CLI standards.
3. **Drafting**:
# Login command
The `login` command authenticates your session with the Gemini CLI services.
## Usage
...
看到没?它会自动应用所有格式规则,你根本不需要操心哪里该加粗,哪里该用代码块。
优势分析
市面上的写作工具不少,但 docs-writer 真的让我按头安利:
- 上下文感知极强:它不会瞎编,它会先去阅读你的代码(Phase 2: Preparation),确保写出来的文档和代码逻辑是完全对应的。这一点对于技术文档来说太重要了!
- 告别“中式英语”:它遵循美式英语标准,自动修正那些尴尬的表达,让你的开源项目文档瞬间拥有国际大厂的风范。
- 维护成本极低:以前改个文档要检查半天格式,现在用这个 Skill,它会自动帮你把关所有的 lint 规则,效率直接翻倍。
应用场景
这个 Skill 在以下场景中简直好用到哭:
- 开源项目维护:当你需要为 Gemini CLI 或类似项目贡献代码时,用它来生成配套文档,Pr 通过率直线上升。
- 文档重构:手里有一堆乱七八糟的老旧 Markdown 文件?让 docs-writer 帮你做一次“大扫除”,统一样式和语气。
- 代码审查辅助:在 Review 别人的文档 PR 时,可以让它帮忙挑刺,找出不符合规范的地方,省时又省力。
最佳实践
想要把 docs-writer Skills 发挥到极致,这里有几个亲测有效的小技巧:
- 明确上下文:在提问前,最好告诉它具体的代码路径,比如“请根据 `packages/cli/src/commands/deploy.ts` 更新部署文档”,这样它的准确率会更高。
- 利用格式化命令:虽然它写得很规范,但建议最后还是配合 `npm run format` 跑一遍,这也是该 Skill 流程中的最后一步建议,双重保险更安心。
- 不要手软:如果你发现它生成的文档语气不对,直接告诉它“Tone Check”,它会立刻根据内置的 Voice guidelines 进行修正。
说实话,自从用了这个工具,我写文档的时间缩短了一半都不止。如果你也想体验这种“全自动”的快乐,想让繁琐的 Markdown 优化工作变得简单,强烈建议去下载体验一下。为了方便大家获取,我已经把这个宝藏资源整理好了,直接去 Skill优仓 就能免费下载使用。别再傻傻手写配置了,赶紧用起来,早搞定早下班!🚀








暂无评论内容