教程读起来不顺
检查标题、步骤、示例和前提条件是否围绕读者任务,而不是作者的实现笔记。
使用 Vercel Labs 的 Writing Guidelines,依据 Vercel 写作手册审查已有文档与文案。指定文件、读者和用途,获取可定位的语言与结构反馈,再结合自己的术语、品牌语气和文档要求,选择适合采纳的修改。
选择你使用的 Agent,查看对应的安装或使用方式。在 Floatboat 中,可复制请求让 Agent 读取原始说明;其他选项会显示该 Skill 的安装命令或发布者提供的原生步骤。
选择 Agent
复制请求,粘贴到 Floatboat 对话
请阅读 https://github.com/vercel-labs/agent-skills/blob/main/skills/writing-guidelines/SKILL.md 中的 Writing Guidelines 原始说明,介绍它的用途、所需工具和安装方式,再协助我使用。由 Agent 读取原始说明,再确认当前环境的使用方式。
下载 Floatboat ↗按当前 Vercel 写作规范审查这些入门文档,给出 file:line 问题,不要改写事实陈述。
Writing Guidelines 是 Vercel Labs 面向已有文档与文案发布的审查 Skill。它先获取当前 Vercel 写作手册,再读取指定文件,并以文件和行号给出简洁反馈,让 Agent 将编辑意见对应到具体文本。它适合有明确读者与用途的教程、参考文档和更新说明,帮助检查语言与结构是否服务于阅读任务。写作手册体现的是 Vercel 的表达偏好,其他团队应结合自身品牌语气、术语和文档规范判断建议。原始流程的重点是审查;生成新内容或直接修改文件,需要另外明确任务范围。
探索教程、API 参考和更新说明中的语言与结构审查任务。提供目标读者与文档用途,让 Agent 对照写作手册检查文本,同时结合已批准的术语、品牌语气和编辑要求,判断哪些建议值得采纳。
检查标题、步骤、示例和前提条件是否围绕读者任务,而不是作者的实现笔记。
检查名称、参数说明、代码格式,以及限制和注意事项的位置。
找出缺乏依据的形容词、缺失的用户影响,以及掩盖实际变更的表述。
选择已有文件,说明读者、用途与需要遵循的术语。让 Agent 获取当前写作手册,返回带位置的审查意见;再逐项核对建议,只应用符合自身文档要求的修改,并检查是否保留原意。
提供文档或文件路径模式。说明目标读者、文档用途,以及需要保留的术语。
让 Agent 获取 Vercel 当前写作手册并检查所选文本。要求反馈简洁,并附文件与行号。
修改前先与自己的文风要求比较。完成后重读相关段落,核对含义、准确性与一致性。
查看其他 Skill 指南,并在使用前核对原始来源。