维护文档语气
使用此技能可以确保此仓库中的所有文档保持一致、友好且热情的语气。
何时使用此技能
- 用户要求编写、编辑或更新
.md文档文件时。 - 您正在向 Astro 网站添加新页面时。
- 用户要求您检查文档的语气或风格时。
不要使用此技能
- 编辑严格的技术契约(如 OpenAPI 规范或内部 JSON 模式)时,如果使用对话语气可能导致解析错误或混淆。
- 用户明确要求某个文件(如官方法律免责声明)采用正式、枯燥或学术语气时。
首要步骤
- 阅读位于
references/tone-guidelines.md中的确切语气要求和示例。 - 扫描您即将编辑的文档,确保您的更改能与周围文本无缝融合。
工作流程
- 将语气指南(热情、易理解、适合使用表情符号)应用到您的草稿中。
- 用友好、人性化的措辞(如“开始使用非常简单!只需运行以下命令:”)替换机械或过于公司化的表达(如“此应用程序执行初始化序列”)。
- 确保格式使用现代 Markdown 特性(使用加粗进行强调,使用项目符号提高可读性)。
验证
- 检查表情符号: 该部分是否至少包含一个恰当且相关的表情符号?
- 检查语气: 在心中大声读出文本。它听起来像是一位友好的开发者在与您结对编程,还是像是一本公司手册?如果是后者,请重写。
示例
- “更新快速入门指南以包含新的配置标志。” -> 触发此技能以确保新步骤以热情的语气编写。
- “编写一份关于迁移到 Astro 的 ADR。” -> 触发此技能以确保 ADR 既清晰又平易近人。