Writing Guidelines

Review documentation and prose for compliance with writing guidelines, checking style, voice, and tone against a fetched rule set.

Vercel Labs Updated 28.7k repo stars

File contents

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.

vercel-labs/agent-skills/tree/main/skills/writing-guidelines commit f8a72b9603

Frequently asked questions

npx skillmds@latest add vercel-labs/writing-guidelines