A tutorial is hard to follow
Check whether headings, steps, examples, and prerequisites follow the user's task rather than the author's implementation notes.
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.
Install and get started
Choose your agent to see how to get started. In Floatboat, copy a request that asks the agent to read the original instructions. Other options show the Skill installation command or the publisher’s native setup steps.
Choose an agent
Start in Floatboat
Copy the request into a Floatboat conversation
Read the original Writing Guidelines instructions at https://github.com/vercel-labs/agent-skills/blob/main/skills/writing-guidelines/SKILL.md. Explain its purpose, required tools, and installation options, then help me use it.Let the agent read the original instructions and check how to use them in your environment.
Download Floatboat ↗Try this request
Review these onboarding docs against the current Vercel writing guidelines. Give file:line findings; do not rewrite factual claims.
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
Explore reviews for tutorials, API references, and release notes that need clearer language or structure. Provide the intended reader and document purpose so the agent can assess the text against the handbook while keeping your approved terminology and editorial requirements in view.
An API reference hides key conditions
Review names, parameter descriptions, code formatting, and the placement of limits or caveats.
A release note sounds vague
Look for unsupported adjectives, missing user impact, and phrases that obscure the actual change.
How to Review Docs with Writing Guidelines
Select the existing files and explain their audience, purpose, and required terminology. Ask the agent to fetch the current writing handbook and return located findings, then review the suggestions and apply only the edits that match your documentation requirements.
- 01
Specify files and audience
Provide the documents or file pattern to review. Include the intended reader, document purpose, and terminology that must be preserved.
- 02
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.
- 03
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.