用途
writing-guidelines 用于审查文档与散文(docs/prose)是否符合 Writing Guidelines 写作规范。当用户提出“review my docs”“check writing style”“audit prose”“review docs voice and tone”等请求时,可使用该工具。
主要能力
- 从指定源 URL 获取最新的写作规范。
- 读取用户指定的文件,或根据用户提供的匹配模式读取文件。
- 将文件内容与获取到的规范中的所有规则进行对照检查。
- 以简洁的 file:line 格式输出发现的问题。
使用方式
-
每次审查前,先从以下源 URL 获取最新规范:
https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md
使用 WebFetch 获取最新规则。获取到的内容包含所有规则及输出格式说明。
-
当用户提供文件或匹配模式参数时:
- 从上述源 URL 获取规范;
- 读取指定文件;
- 应用获取到的规范中的所有规则;
- 使用规范中指定的格式输出发现的问题。
-
如果用户未指定文件,则询问用户需要审查哪些文件。
适用场景
- 审查文档是否符合写作规范。
- 检查写作风格。
- 审计散文内容。
- 审查文档的语气与语调(voice and tone)。
限制
- 规范内容依赖外部源 URL,需通过 WebFetch 获取。
- 未提供文件或匹配模式时,需先向用户询问。
- 关于收费、价格、平台支持范围等信息,资料中暂未提供。