writing-guidelines

Original：🇺🇸 English
Translated

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

63.3kinstalls
Sourcevercel-labs/agent-skills
Added on

NPX Install

npx skill4agent add vercel-labs/agent-skills writing-guidelines

Tags

Translated version includes tags in frontmatter
writing-guidelinesdoc-reviewprose-auditstyle-checkcontent-compliance

SKILL.md Content

View Translation Comparison →

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.