用途
good-docs-writing 是一份文档写作风格指南，用于撰写或编辑文档、指南、教程，以及其他需要保持特定语气的技术性文章。它的风格来源是 Modal 的文档语气，主张「像 Modal 那样写文档」：直接、友好、自信、极度务实。
主要能力
该指南提供了一套可逐条执行的写作规则，并附带完整的规则集文件 references/style-guide.md，其中涵盖：
- 语气（Voice）
- 结构（Structure）
- 术语（Terminology）
- 标点（Punctuation）
- 代码示例（Code examples）
- 格式（Formatting）
在起草过程中，需要应用该文件中的每一条规则。
使用方式
在撰写内容时套用这些规则，并在打开参考文件之前先遵守下列最关键的几条：
- 用「you」称呼读者，绝不用「the user」或「one」。
- 第一句话就给出概念或收益，不要做无谓铺垫（no throat-clearing）。
- 在靠前位置放一个最小可运行示例，然后解释刚才发生了什么。
- 删除所有破折号（em-dash），改用句号、逗号、冒号或括号。
- 删掉含糊的强化词（如 seamlessly、powerful、robust、cutting-edge）。与其说某件事「简单」，不如直接展示它简单。
- 对每一个代码标识符、命令、参数、路径和文件名都加上反引号。
如果要评审既有文字是否符合这些规则，而不是起草新内容，则改用 good-docs-audit。
适用场景
适用于撰写或编辑文档、指南、教程，以及需要采用上述语气和风格的技术性文字。
限制
本次资料未提供关于收费、价格、平台支持范围或具体效果的信息，以上内容暂未提供。