writing-guidelines

Review documentation files for compliance with fetched writing style guidelines.

Updated Jul 29, 2026
One-click install
npx skills add https://github.com/zomeru/zomlab --skill writing-guidelines-zomeru
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-guidelines
Source: https://github.com/zomeru/zomlab/tree/main/.agents/skills/writing-guidelines
Command: npx skills add https://github.com/zomeru/zomlab --skill writing-guidelines-zomeru

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to keep documentation consistent with their writing style handbook, and manually auditing prose for voice, tone, and style rule violations is slow and error-prone. ## Core Features & Use Cases - Fresh Rule Retrieval: Fetches the latest writing guidelines from a remote source URL before every review, so audits always use current rules. - File and Pattern Review: Reads specified files or glob patterns and checks them against every rule in the fetched guidelines. - Terse Findings Output: Reports violations in a compact file:line format for quick triage and fixes. - Use Case: Before publishing a new docs page, ask for a review of the file to catch style violations such as tone mismatches or formatting inconsistencies against the team handbook. ## Quick Start Review the file docs/getting-started.md against the writing guidelines and list any violations.

Frequently Asked Questions about writing-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review my docs against writing style guidelines?▼

Provide a file path or pattern as the argument, and the skill fetches the latest guidelines from the source URL, reads your files, and checks them against every rule. Findings are reported in a terse file:line format.

What tool checks documentation voice and tone automatically?▼

This skill audits prose for voice and tone by fetching the vercel-labs writing-guidelines ruleset and applying all its rules to your specified files. It outputs violations with exact file and line references.

Does the writing guidelines review use the latest rules?▼

Yes, the skill fetches fresh guidelines from the remote source URL before each review using WebFetch. This ensures every audit applies the most current version of the rules rather than a cached copy.

What happens if I do not specify files to review?▼

If no file or pattern argument is provided, the skill asks you which files to review. You can then supply a specific file path or a glob pattern covering multiple documents.

What output format does the docs review produce?▼

Findings are output in a terse file:line format as specified by the fetched guidelines. Each violation points to the exact location in the file so you can navigate directly to the issue.