返回技能库
内
内容精选
Vercel Writing Guidelines:文档与内容规范
按 Vercel 写作规范审查文档与页面文案,检查结构、语气、代码示例和 AI 工作流表达。
技能说明
适合 README、产品文档、帮助中心、教程和页面文字的发布前复核。技能会先抓取最新规则,再按文件和行号给出简明问题;它是审查工具,不会自动替你改稿。需要允许 Agent 访问公开规则源:https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md。
关于此技能
这是一个面向文档和页面文字的发布前审查流程。它会先抓取最新的写作规则,再按文件和行号给出简明、可复核的修改建议,帮助团队保持结构、语气和示例的一致性。
核心能力
结构与可读性检查
检查标题、开头、段落和列表是否符合读者真正要完成的任务。
语气与表达检查
审查主动语态、直接称呼、术语、禁用词和不同内容类型的表达方式。
代码示例检查
检查示例中的语言标注、结构、占位符和文档使用方式。
AI 工作流表达检查
检查文档是否清楚说明计划、责任边界和 AI 使用方式,减少含糊承诺。
适用场景
README 与开发文档
在合并前检查项目说明、教程和 API 文档是否清楚、完整、易维护。
帮助中心与产品页面
复核产品说明、定价页面和用户指引的结构、语气与表达一致性。
内容发布前自检
对指定文件或匹配范围做一次有规则依据的编辑审查,而不是泛泛润色。
使用步骤
- 01
指定文件范围
提供一个文件或匹配范围,让 Agent 明确本次审查的边界。
- 02
获取最新规则
从 Vercel Writing Guidelines 的公开地址读取当前规则,不使用过期副本。
- 03
逐项核对内容
按规则检查结构、语气、代码、排版和 AI 工作流表达。
- 04
输出定位建议
以 file:line 格式输出问题,回到原文件逐条决定如何修改。
常见问题
它会自动改写文档吗?+
不会。它默认输出定位清晰的审查结果,是否修改以及如何修改由你决定。
需要联网吗?+
需要。技能要求读取最新的公开规则文件;如果无法访问规则源,应先说明并停止完整审查。
没有指定文件会怎样?+
技能会先要求你提供文件或匹配范围,不会擅自扫描整个项目。
安装命令
npx skills add vercel-labs/agent-skills --skill writing-guidelines -a codex -a claude-code -a cursor -y适用平台与标签
CodexClaude CodeCursor#Vercel#文档#写作规范#README#内容审查