bingran.you
← Skills
Other

writing-guidelines

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

Triggers

  • review my docs
  • check writing style
  • audit prose
  • review docs voice and tone
  • writing handbook
  • 文档审查

SKILL.md

Writing Guidelines

Review files for compliance with Writing Guidelines.

How It Works

  1. Load the pinned guidelines from references/guidelines.md — this is the default, reproducible execution path
  2. Optionally, fetch the latest guidelines from the upstream URL below and diff against the pinned snapshot to see if anything has changed
  3. Read the specified files (or prompt user for files/pattern)
  4. Check against all rules in the guidelines
  5. Output findings in the terse file:line format

Guidelines Source

Default (pinned): The vendored copy at references/guidelines.md is the default execution path. It is a pinned snapshot of the upstream guidelines and guarantees the skill produces reproducible results in any runtime environment.

Upstream (live): For users who want the very latest rules, the live source is available at:

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

Fetching the live version is optional — the pinned snapshot is always the baseline.

Usage

When a user provides a file or pattern argument:

  1. Load references/guidelines.md as the default source
  2. Optionally fetch the upstream URL to check for updates
  3. Read the specified files
  4. Apply all rules from the guidelines
  5. Output findings using the format specified in the guidelines

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

License

MIT License

Copyright (c) 2026 Vercel Labs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.