关于 good-docs-writing
指导以 Modal 直接、实用的风格撰写开发者文档的技能，涵盖结构、示例、术语和标点规则，并指出可用 `good-docs-audit` 审查现有文本。
主要功能
- 01开篇说明概念或收益
- 02在前部放置可运行示例
- 03遵循简洁的风格与标点规则
- 04规范代码标识符和路径格式
适用场景
- 01撰写开发者文档
- 02在指南开头加入可运行示例
- 03统一文档风格
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/good-docs-writing确认已加载。
附带文件references/style-guide.md
详细介绍
撰写优质文档
按照 Modal 的写作方式来写文档：直接、友好、自信，并且极度务实。用一句话讲清楚 为什么，然后展示可以运行的代码。把读者当作有能力的开发者，他们想要的是尽快上线，而不是听一堂课。
在打开参考资料之前，先记住以下最重要的规则：
- 用“你”称呼读者，不要用“用户”或“一个人”。
- 第一句就点明概念或收益，不要绕弯子、不要铺垫。
- 在靠近开头的位置放一个最简的可运行示例，然后解释刚才发生了什么。
- 删掉所有破折号。改用句号、逗号、冒号或括号。
- 去掉含糊的强调词（如“无缝”“强大”“稳健”“前沿”）。用实际效果展示某件事很容易，而不是直接宣称它很容易。
- 所有代码标识符、命令、参数、路径和文件名都要用反引号括起来。
如果要审查现有文本是否符合这些规则，而不是起草新内容，请使用 good-docs-audit。
评论
支持 Markdown