用途:在解决 Vale 检查输出或编辑适用 Vale 风格的文档时使用该技能,适合修复 PR 或文件中的 Vale 错误与警告、用户要求修复 Vale 问题或遵循 Vale 风格,以及编辑文档和正文语法风格的场景。
必要验证:编辑文档后必须运行 pnpm run vale <filename>,确认 0 错误、0 警告、0 建议后方可视为完成。
必须修复(错误)规则:标题使用句式大小写(仅首词和专有名词大写),必要时在 .vale/styles/StyleRules/Headings.yml 添加产品名例外;句末标点后一个空格,em/en dash 两侧不留空格,引导说明的标签或粗体短语后使用冒号而非 em dash;em dash 仅用于连接正文中相关句子片段,列表项中禁用 em dash,改用冒号分隔格式;三项及以上列表在 and/or 前加逗号;每篇文档需含 description 字段(约 150 字符,以句号结尾)。
建议修复(警告)规则:以 you 称呼读者,避免第一人称(we、our、let's),例外为 Let's Encrypt、US,粗体中的第一人称属 UI 文本不可编辑;时间写作 3:00 PM / 9:30 AM;日期写作 Month Day, Year;省略号用 … 而非 ...;不使用感叹号,使用 they/them/their;标题末尾不加句号;用 for example、that is 代替 e.g.、i.e.;-ly 词后不加连字符;避免括号可选复数(如 user(s));缩写不加句点(API、HTTP);使用美式拼写;ngrok 术语 Traffic Policy、Kubernetes Operator、Traffic Inspector、Cloud Endpoint、Agent Endpoint 需大写。完整错误警告文本、示例与例外见 reference.md。
限制:以上为资料提供的规则与验证要求,未提供的内容暂未说明。