writing-guidelines

vercel-labs/agent-skills

Review documentation and prose for compliance with Writing Guidelines.

What is writing-guidelines?

This skill audits files against a centralized Writing Guidelines ruleset, checking for style, voice, tone, and formatting compliance. Use it when you need to review documentation, validate prose against standards, or audit content voice and tone.

Fetches the latest Writing Guidelines from the source repository
Reads and analyzes specified files or file patterns
Checks content against all rules in the fetched guidelines
Outputs findings in terse file:line format for easy remediation
Supports batch review of multiple files

How to install writing-guidelines

npx skills add https://github.com/vercel-labs/agent-skills --skill writing-guidelines

Claude Code

Cursor

Windsurf

Cline

How to use writing-guidelines

1.Provide the file path or pattern to review (e.g., docs/*.md or a specific file)
2.The skill fetches the latest guidelines from the source repository
3.Review the output findings in file:line format
4.Address flagged issues according to the guidelines rules
5.Re-run the skill to verify compliance after edits

Use cases

Good for

Review documentation before publishing to ensure consistent voice and tone
Audit existing prose against updated writing standards
Check multiple files for style compliance in a single pass
Validate new documentation submissions against the writing handbook
Ensure technical docs follow organizational writing guidelines

Who it's for

Technical writers
Documentation maintainers
Content reviewers
Development teams maintaining docs
Quality assurance for written content

writing-guidelines FAQ

What guidelines does this skill check against?

It fetches the latest rules from https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md before each review, ensuring you always validate against current standards.

What file formats does it support?

The skill works with any text-based files. Specify files by path or pattern (e.g., docs/*.md).

What if I don't specify files?

The skill will prompt you to provide the files or patterns you want to review.

How are findings reported?

Findings are output in terse file:line format for quick scanning and remediation.

Full instructions (SKILL.md)

Source of truth, from vercel-labs/agent-skills.

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

Fetch the latest guidelines from the source URL below
Read the specified files (or prompt user for files/pattern)
Check against all rules in the fetched guidelines
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:

Fetch guidelines from the source URL above
Read the specified files
Apply all rules from the fetched guidelines
Output findings using the format specified in the guidelines

vercel-labs/agent-skills

Implement smooth, native-feeling animations using React's View Transition API without third-party libraries.

69k installsAudited