writing-guidelines
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".
How do I install this agent skill?
npx skills add https://github.com/nexu-io/open-design --skill writing-guidelinesIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill is safe to use. It audits documentation files for style and voice compliance using either a local reference or a remote source from a trusted organization.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Writing Guidelines
Review files for compliance with Writing Guidelines.
How It Works
- Load the pinned guidelines from
references/guidelines.md— this is the default, reproducible execution path - Optionally, fetch the latest guidelines from the upstream URL below and diff against the pinned snapshot to see if anything has changed
- Read the specified files (or prompt user for files/pattern)
- Check against all rules in the guidelines
- Output findings in the terse
file:lineformat
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:
- Load
references/guidelines.mdas the default source - Optionally fetch the upstream URL to check for updates
- Read the specified files
- Apply all rules from the guidelines
- Output findings using the format specified in the guidelines
If no files specified, ask the user which files to review.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/nexu-io/open-design/writing-guidelines">View writing-guidelines on skillZs</a>