Writing Guidelines review

Reviews docs and prose against Vercel's writing handbook, fetched fresh on each run, and lists findings as file:line: voice, structure, headings, code samples, units, typography. Use when checking English docs before publishing.

DocumentationPack: Vercel skillslinkwriting-guidelines
Author
Source
vercel-labs/agent-skills/skills/writing-guidelines @ 1a2c79d
License
none stated

About this skill

What it does

The skill reviews documentation and other prose against Vercel's writing handbook. Like its UI twin in this pack it carries no rules: on every run the agent fetches them from command.md on the main branch of the separate vercel-labs/writing-guidelines repository, reads the files or glob you name (or asks which ones), checks each against all rules, and prints findings grouped by file in clickable file:line form.

The repository README counts over eighty rules. Planning: a content plan, a declared content type, titles shaped as the user's question. Voice: active voice, direct "you", no "easy", "simple" or "quick". Tone by content type, from tutorial to troubleshooting. Headings in sentence case. Code: language tags, TypeScript first, a <Steps/> component, 80-column and 25-line limits. Units such as 64 KB and 200 ms. Typography: no em dashes as punctuation, curly quotes, the ellipsis character. No hard wraps in the source. Pricing pages, AI workflow and PR review close the list.

When to use it, and when not

Use it on English docs pages, guides and READMEs before publishing, when you want a line-by-line list of style problems rather than a rewrite.

The rules are Vercel's house style: <Steps/>, content-type metadata and the em dash ban fit Vercel's docs and may not fit yours, so expect findings to discard. They are written for English, not Russian. The skill reports and does not edit. It needs network access and a web fetch tool (SKILL.md names WebFetch), and because the rules are unpinned, results can change when the handbook does.

How to run it

We do not copy this skill: it names no licence and the repository ships no licence text. Install it from Vercel's repository with the button to the source; the README's installer is npx skills add vercel-labs/agent-skills, and --skill writing-guidelines limits it to this one. Pass a file or a pattern:

  • Claude Code: /writing-guidelines, or ask for the skill by name.
  • Codex: $writing-guidelines.
  • Cursor: type / in the Agent chat and pick writing-guidelines.

Example: /writing-guidelines content/docs/getting-started/*.mdx

How it differs from similar skills

README writer and API docs writer write documentation from the code and verify each command and example; this skill checks the style of text that already exists. Document co-authoring workflow builds a document with you through questions and a reader test. Writing for agents is for text an agent reads. Web Interface Guidelines review runs the same mechanism on UI code.

Install

This skill is not copied to the catalog: the author's repository has no licence text. Install it from there.

Open the source

Connect through AnyModel API

This skill runs on whatever model your agent uses. Point Claude Code, Codex or Cursor at AnyModel to run it on Claude, GPT, Gemini and more with one key — pay per token, no subscription.

More from the pack Vercel skills

React and Next.js performance rules

Gives the agent Vercel's 70 React and Next.js performance rules, ranked by impact: request waterfalls, bundle size, server work, re-renders, rendering. Use when writing, refactoring or reviewing React or Next.js code for speed.

React composition patterns

Applies eight Vercel rules that replace boolean props with compound components, provider-held state and explicit variants, plus React 19 ref and use() changes. Use when a component has too many flags or when designing a component library.

React Native best practices

Applies Vercel's React Native and Expo rules: virtualized lists, transform and opacity animations, native navigators, expo-image, state, monorepo setup. Use when building or speeding up a mobile app or reviewing React Native code.

React view transitions

Implements animations with React's View Transition API: shared element morphs, Suspense reveals, list reorder and directional route slides, with CSS recipes and Next.js integration. Use when adding page or state transitions to a React or Next.js app.

Deploy to Vercel, Vercel Labs

Deploys a project to Vercel as a preview, choosing git push, CLI deploy, linking first or a temporary deploy without an account by the project's state, and returns the URL. Use when asked to deploy an app and get a link.

Vercel CLI with tokens

Runs the Vercel CLI from an access token instead of a browser login: finds the token, deploys previews, manages env vars, logs and domains, keeps the token out of command flags. Use when working with Vercel from a non-interactive shell.

Vercel cost and performance tuning

Audits a deployed Vercel project for cost and performance: collects metrics first, picks candidates by fixed thresholds, inspects only flagged routes and returns verified, cited recommendations. Use when cutting a Vercel bill or fixing slow routes.

Web Interface Guidelines review

Reviews UI code against Vercel's Web Interface Guidelines, fetched fresh on each run, and lists findings as file:line: accessibility, focus, forms, animation, typography, images, performance. Use when checking components or pages before a pull request.