Writing Guidelines by Vercel Labs

Use Writing Guidelines by Vercel Labs to review existing documentation and prose against Vercel’s writing handbook. Specify the files, audience, and purpose, then inspect located feedback on language and structure while deciding which suggestions fit your own terminology, brand voice, and documentation requirements.

Make onboarding instructions easier to follow

Provide the draft, its reader, and the operation the text must explain. Frame a writing review around terminology, prerequisites, and examples, with proposed edits preserving confirmed technical meaning rather than replacing useful detail with a generic style preference.

Include the document and its reader; identify facts that must stay unchanged.

Copy the request into a new Floatboat conversation and provide the required material.

Download Floatboat

Your request for Floatboat

Preview and copy the request. It is not sent automatically from this page.

Reference: Writing Guidelines
https://github.com/vercel-labs/agent-skills/blob/main/skills/writing-guidelines/SKILL.md

Read the original documentation and check the current environment and dependencies. Propose any new installation or tool connection before proceeding.

My task:
Review these onboarding docs against the current Vercel writing guidelines. Give file:line findings; do not rewrite factual claims.

Expected deliverable:
File-and-line editorial findings that distinguish wording issues from facts needing confirmation.

About Writing Guidelines

Writing Guidelines is a Vercel Labs Skill for reviewing existing documentation and prose. It retrieves the current Vercel writing handbook, reads specified files, and reports concise findings at file and line locations. The workflow helps an agent connect editorial feedback to the exact text that needs attention, rather than returning a general impression of the document. It suits tutorials, reference pages, and release copy with a defined audience and purpose. The handbook reflects Vercel’s writing preferences, so another team should assess recommendations against its own voice and terminology. Drafting new content or applying edits is a separate task from the documented review.

Use Cases for Writing Guidelines Skill

Tutorials, API references, and release notes answer different reader questions. Compare how Writing Guidelines organizes prerequisites, parameter conditions, and verified user impact without substituting implementation notes or vague promotional language for useful explanations.

A tutorial is hard to follow

A tutorial should follow the reader's starting knowledge and the operation they want to complete. Compare headings, steps, examples, and prerequisites with that task rather than the author's implementation history. Revise missing conditions and broken transitions so a reader can continue from one action to the next.

An API reference hides key conditions

An API reference needs clear names, parameter descriptions, and examples that match confirmed limitations. Review code formatting alongside where conditions and caveats appear, keeping them close to the operations they affect. The revised reference should make usage requirements discoverable before a reader encounters an avoidable error.

A release note sounds vague

A release note should explain verified behavior changes and their effect on users. Compare the draft with the release diff, replacing vague adjectives and phrases that obscure what changed. Keep unverified claims separate so the published explanation does not promise improvements the evidence cannot establish.

Align terminology across related documents

A tutorial, API reference, and release note may describe the same feature with conflicting terms. Compare those expressions against confirmed names and behavior, then propose wording that keeps the reader's understanding consistent. Preserve genuine differences in conditions or meaning rather than making every phrase identical, and do not silently rename code or product concepts during an editorial revision.

How to Review Docs with Writing Guidelines

Editing starts with the draft, its reader, and the operation the text should explain. Compare the document with the relevant writing rules, then revise specific passages while preserving verified terminology, technical conditions, and the intended meaning of examples.

  1. Specify files and audience

    Provide the documents or file pattern to review. Include the intended reader, document purpose, and terminology that must be preserved.

  2. Review with the current handbook

    Ask the agent to fetch Vercel’s writing handbook and inspect the selected text. Request concise findings with file and line locations.

  3. Select and verify edits

    Compare suggestions with your own style requirements before editing. Reread the changed passages for meaning, accuracy, and consistency.

Explore More Agent Skills

Read another Skill guide and check its original source before using it.

Writing Guidelines FAQ

Is Writing Guidelines a writing generator?
No. The documented workflow reviews existing docs or prose and reports issues. Generating new content would need a separate task.
Where are the rules stored?
The installed SKILL.md points to the separate Vercel writing-handbook source and asks the agent to fetch it fresh for each review.
Can I apply it to non-Vercel docs?
You can use it as a review lens, but its style preferences belong to Vercel. Keep your own brand and documentation requirements authoritative.
What input does it need?
Provide a file or pattern to review. The original workflow asks for target files if none are specified.
How should a review preserve an established brand voice?
Provide the intended audience and approved terminology alongside the files. Separate a concrete clarity problem from a stylistic preference, and keep terminology consistent instead of replacing distinctive language mechanically.
What if the current guideline source cannot be retrieved?
State that the source could not be checked. You can still review obvious spelling or clarity issues, but should not claim that the text passed the latest source-specific rules.
What should I do when Vercel’s handbook conflicts with our style guide?
State which local editorial requirements govern the document and ask the agent to identify conflicts. Use handbook findings as review input, then retain the wording and conventions required by your own documentation.