Index of every page on this site: llms.txt
All skills
vercel-labs avatar

/writing-guidelines

@5a37a63 official
by Vercel Labsvercel-labs/agent-skills35k stars
3,011
Run it yourself

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".

Use this Skill: https://skilld.dev/gh/vercel-labs/agent-skills/writing-guidelines

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈57 tokens for metadata: the name and description. ≈224 when used: this file.

Description uses 2.9% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈228 characters, or 2.9%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning5mo3 checks · Risk SAFE
  • Gen Agent Trust Hub5mo

    This skill reviews documentation for style compliance by fetching guidelines from a trusted source. It performs its tasks using standard agent capabilities and does not exhibit any suspicious or risky behaviors.

  • Socket5mo

    No alerts

  • Snyk5mo

    Risk: MEDIUM · 2 issues

Signed by skilld at 5a37a63. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 10 hours ago.

Activeupdated 6 months ago
Other metadata
metadata
{
  "author": "vercel",
  "version": "1.0.0",
  "argument-hint": "<file-or-pattern>"
}

README badge

README badge for vercel-labs/agent-skills/writing-guidelines

Fetches the latest Vercel writing guidelines from a remote source and reviews provided files or documentation against those rules, reporting violations in a terse format. Use this when auditing prose for compliance with style, voice, and tone standards.

Generated from the current SKILL.md.

What writing guidelines does this skill check against?
It fetches the latest guidelines from vercel-labs/writing-guidelines on GitHub, so it always uses the current ruleset without needing manual updates.
Can I review a single file or do I need to provide a pattern?
You can provide either a single file or a glob pattern. If you don't specify either, the skill will prompt you to choose which files to review.
What format are the findings reported in?
Findings are output in `file:line` format as specified by the fetched guidelines.
Does this skill work with any file type?
Yes, it will review any files you specify, but it's designed for documentation and prose-heavy content.

Generated from the current SKILL.md. These answers refresh after source changes.