writing-guidelines

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

Updated Sep 6, 2026
One-click install
npx skills add https://github.com/AbuBakar125-co/Resturant_web --skill writing-guidelines-abubakar125-co
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-guidelines
Source: https://github.com/AbuBakar125-co/Resturant_web/tree/main/.agents/skills/writing-guidelines
Command: npx skills add https://github.com/AbuBakar125-co/Resturant_web --skill writing-guidelines-abubakar125-co

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping documentation consistent with a team's writing style guide is tedious and error-prone when done manually. This Skill automates prose review by fetching the latest writing guidelines and checking your files against every rule. ## Core Features & Use Cases - Fresh Guideline Fetching: Retrieves the latest rules from the vercel-labs writing-guidelines source URL before each review, so checks never go stale. - Rule-Based Prose Audit: Applies all fetched rules to the specified files or glob patterns and reports every violation. - Terse Output Format: Reports findings in a compact file:line format for quick navigation and fixing. - Use Case: Before publishing a docs update, ask the Skill to review your changed Markdown files and get a precise list of style violations with line numbers. ## Quick Start Ask the assistant to review docs/guide.md against the writing guidelines and list all violations.

Frequently Asked Questions about writing-guidelines

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

FAQPage Schema
How do I check my docs against a writing style guide?▼

Provide a file path or glob pattern, and the Skill fetches the latest writing guidelines from the source URL, reads your files, and reports every rule violation in a terse file:line format.

What writing guidelines does this Skill check against?▼

It fetches rules from the vercel-labs/writing-guidelines repository's command.md file on GitHub. The guidelines are retrieved fresh before each review, so checks always use the current rule set.

Can I review multiple documentation files at once?▼

Yes, you can pass a file pattern or list of files as the argument. If you provide no files, the Skill asks which files you want reviewed before proceeding.

Does the writing review work offline?▼

No, the Skill requires network access to fetch the latest guidelines from the raw GitHub URL using WebFetch. Without connectivity, it cannot retrieve the rules needed to perform a review.

What output format does the docs review produce?▼

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