01 / Skill 档案 · 文档 · 编辑审查

Writing Guidelines:审查真正要发布的文档

这个写作审查 Skill 会获取 Vercel 当前的写作手册,阅读指定文件,并指出具体的语言和结构问题。

发布方、原始来源与安装方式

原发布方 Vercel Labs · 类型: 文档审查 Skill

本页为独立介绍;Vercel Labs 未对 Floatboat 作出背书。

上游安装方式

npx skills add vercel-labs/agent-skills --skill writing-guidelines

安装的是上游指令;审查时还需要获取发布方当前的写作手册。

一个具体请求

它不是通用文案生成器。原始流程要求获取最新写作规范,检查指定文档或文案文件,并用简洁的文件与行号呈现发现。

向 Agent 提问

“按当前 Vercel 写作规范审查这些入门文档,给出 file:line 问题,不要改写事实陈述。”

应该得到什么

合格审查会区分不清楚的操作说明与品牌文风偏好,并标出受影响行。

这个写作审查适合什么

用它检查需要按规范复核的具体文档或文案文件。

文档

教程读起来不顺

检查标题、步骤、示例和前提条件是否围绕读者任务,而不是作者的实现笔记。

参考

API 参考页埋没了使用条件

检查名称、参数说明、代码格式,以及限制和注意事项的位置。

文案

更新说明过于空泛

找出缺乏依据的形容词、缺失的用户影响,以及掩盖实际变更的表述。

它不能独自决定什么

  • 核查未提供来源的产品行为事实。
  • 未经确认就用 Vercel 的品牌文风替代团队自身的编辑规范。

文档审查的工作流程

先读当前规范和指定文件,再反馈具体问题,而不是脱离上下文地重写。

  1. 01

    指定文档

    提供文件或路径模式,并说明内容属于教程、参考文档或其他类型。

  2. 02

    获取最新手册

    原始指令要求每次审查前重新获取写作手册。

  3. 03

    有选择地接受修改

    将定位问题与事实准确性、团队文风逐一对照。

02 / 使用指南

结合文档类型审查文字

教程、参考页和故障排查文档承担不同任务;应用规则前先确定内容类型。

这个 Skill 会写新文档吗?

原始用途是审查:获取最新手册、检查指定文件、报告定位问题。之后可让 Agent 协助修改,但那属于另一个指令和编辑决定。

其他团队要原样采用 Vercel 文风吗?

不一定。这些是 Vercel 的发布方专属写作规则。接受修改前,应与自己的品牌语气、本地化需求及文档契约比较。

你能拿到什么

  • 按文件和行号定位的文字问题
  • 与目标文档相关的结构和清晰度问题
  • 待接受或驳回的修改短名单

使用前先核对

  • 是否获取了当前规范?
  • 修改是否保留文档事实?
  • Vercel 的品牌文风是否适合当前发布者?

探索更多 Agent Skills

查看其他 Skill 指南,并在使用前核对原始来源。

常见问题

Writing Guidelines 是写作生成器吗?
不是。原始流程审查已有文档或文案并反馈问题;生成新内容需要另行提出任务。
规则保存在哪里?
安装的 SKILL.md 指向独立的 Vercel 写作手册来源,并要求 Agent 每次审查时重新获取。
非 Vercel 文档可以用吗?
可以作为审查视角,但其文风偏好属于 Vercel。你的品牌和文档要求仍应优先。
使用时需要提供什么?
需要提供待审查文件或路径模式;如果没有指定,原始流程会先询问。

03 / 下一步 · 打磨草稿

让草稿与审查意见在同一处推进

把目标文档和修改决定放在 Floatboat 中推进,同时保留 Vercel 写作手册的来源归属。