Skip to content
Writing Guidelines

Writing GuidelinesSkill

Released
v1.0.0
MIT
Repository Docs

Summary

Vercel's official skill for reviewing documentation and prose against its writing handbook — voice, structure, code samples and typography, reported as file:line findings.

Features

  • Reviews docs and prose against Vercel's writing handbook
  • Rules for voice, tone, structure and content type
  • Conventions for code samples and typography
  • Guidance for prose consumed by AI agents
  • Outputs terse file:line findings
  • Always fetches the current ruleset before reviewing

Install This Skill

Add this skill to your favorite AI agent in a few steps.

Any AI agent

This skill is plain instructions — it works with any assistant that accepts custom instructions or system prompts.

  1. Copy the skill content with the button below.
  2. Paste it into your agent's instruction file or system prompt (for example AGENTS.md, .cursorrules, or a custom instructions field).
  3. Ask the agent to apply the skill whenever the task matches.

Skill Content

Markdown Content

Copy this content and use it with your preferred AI agent

---
name: writing-guidelines
description: Review docs/prose for Writing Guidelines compliance. Use when asked to "review my docs", "check writing style", "audit prose", "review docs voice and tone", or "check this page against the writing handbook".
metadata:
  author: vercel
  version: "1.0.0"
  argument-hint: <file-or-pattern>
---

# Writing Guidelines

Review files for compliance with Writing Guidelines.

## How It Works

1. Fetch the latest guidelines from the source URL below
2. Read the specified files (or prompt user for files/pattern)
3. Check against all rules in the fetched guidelines
4. Output findings in the terse `file:line` format

## Guidelines Source

Fetch fresh guidelines before each review:

```
https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md
```

Use WebFetch to retrieve the latest rules. The fetched content contains all the rules and output format instructions.

## Usage

When a user provides a file or pattern argument:
1. Fetch guidelines from the source URL above
2. Read the specified files
3. Apply all rules from the fetched guidelines
4. Output findings using the format specified in the guidelines

If no files specified, ask the user which files to review.

Description

Writing Guidelines is an official agent skill from Vercel that applies the company's internal writing handbook to your documentation the same way a linter applies rules to code.

Point it at a docs page, a README or a changelog entry — "review my docs", "check writing style", "audit prose" — and it fetches the current ruleset from the vercel-labs/writing-guidelines repository, reads the files you name, and returns violations as terse file:line findings.

What it checks. The handbook covers voice and tone, document structure and heading hierarchy, the conventions that differ by content type (a tutorial is not a reference page is not a release note), how code samples should be written and introduced, typography and punctuation, and guidance for prose that will be read by AI agents as well as by people.

Why a skill rather than a style guide in a wiki. A style guide only works if someone remembers to apply it. As a skill it runs on demand against the actual file, catches the drift that accumulates when a dozen people write docs, and gives a reviewer something concrete to point at instead of "this doesn't sound like our docs".

Who it is for. Developer-experience and documentation teams, open-source maintainers who want consistent READMEs across repositories, and engineers who write docs but would rather not memorise a handbook to do it.

Like the rest of the collection the ruleset is fetched fresh on each run rather than vendored, so reviews track upstream automatically. MIT-licensed, part of vercel-labs/agent-skills, installable with npx skills add vercel-labs/agent-skills, and compatible with any agent that reads SKILL.md.

Related Skills

Skill: The GTM Co-Founder

by Shane O'Connor

Featured

An open-source set of go-to-market skills for solo technical founders — positioning, first users, launch and pricing, sequenced into a roadmap your agent works with you.

New

Drive a HEY account from an agent through the HEY CLI — Imbox and screener, threads, replies, drafts, contacts, calendar, todos, habits, time tracking and journal entries.

Browse all skills →