writing-guidelines

Review documentation files against fetched writing style guidelines and report violations.

Updated Aug 26, 2026
One-click install
npx skills add https://github.com/MohamadJoumaa/Direct --skill writing-guidelines-mohamadjoumaa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-guidelines
Source: https://github.com/MohamadJoumaa/Direct/tree/main/.cursor/skills/writing-guidelines
Command: npx skills add https://github.com/MohamadJoumaa/Direct --skill writing-guidelines-mohamadjoumaa

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping documentation consistent with a writing style guide is tedious when done manually. This Skill automates prose audits by fetching the latest Writing Guidelines rules and checking your files against every rule, so style drift is caught before publication. ## Core Features & Use Cases - Fresh Rule Fetching: Retrieves the latest guidelines from the vercel-labs/writing-guidelines repository before each review, so checks never go stale. - File or Pattern Review: Accepts a specific file or glob pattern as an argument, or prompts you for targets when none are given. - Terse Findings Output: Reports violations in a compact file:line format that is easy to scan and act on. - Use Case: Before merging a docs pull request, run the review on the changed Markdown files to catch voice, tone, and style violations in seconds. ## Quick Start Ask the assistant to review 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 glob pattern as the argument, and the Skill fetches the latest Writing Guidelines rules, reads your files, and checks them against every rule. Findings are reported in a terse file:line format.

What writing guidelines does this style review use?

It fetches the rules from the vercel-labs/writing-guidelines repository's command.md file on GitHub before each review. This ensures the audit always uses the most current version of the guidelines rather than a cached copy.

Can I review multiple documentation files at once?

Yes, you can pass a file pattern instead of a single file to review multiple documents in one run. If you provide no argument, the Skill asks which files you want reviewed.

What output format does the writing review produce?

Findings are output in a terse file:line format, with each violation pointing to the exact location in the reviewed file. The precise output format instructions come from the fetched guidelines content.

Why does the review need network access?

The Skill fetches fresh guidelines from a raw GitHub URL before each review using WebFetch. Without network access, it cannot retrieve the current rule set and cannot perform an accurate audit.