Description
writing-guidelines is an agent skill from Vercel's agent-skills collection, listed on skills.sh. It reviews documentation and prose for compliance with a set of writing guidelines. When asked to review docs, check writing style, audit prose or review voice and tone, the agent first fetches the latest guidelines from the source URL, which is kept in the vercel-labs writing-guidelines repository. It then reads the files the user names, or asks for a file or pattern if none is given, and checks them against every rule in the fetched guidelines. Findings are reported in a terse file-and-line format, so each one can be found and fixed quickly. Because the guidelines are fetched fresh before each review, the checks follow the current version of the rules. It is for documentation writers and editors who want a consistent style across docs and articles, and who want a mechanical first pass before a human editor reviews the text.…
Highlights
- Checks docs and prose against current guidelines
- Fetches the latest rules before each review
- Findings as file:line entries
- Covers voice and tone
Ratings & Reviews
No ratings yet
Be the first to rate writing-guidelines.
People also visit
writing-guidelines FAQ
What does the writing-guidelines skill do?
It reviews files for compliance with a writing guideline set and reports each finding with its file and line.
How do I install it?
Run: npx skills add https://github.com/vercel-labs/agent-skills --skill writing-guidelines
Where do the rules come from?
The skill fetches them from the writing-guidelines repository on GitHub before each review.
What does the output look like?
A terse list of findings in file:line format.
Has it been checked for security?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Warn. A Warn or Fail is worth reading before you install.
What are the best writing-guidelines alternatives?
Popular alternatives to writing-guidelines include edit-article, docs-review and baoyu-format-markdown. See all writing-guidelines alternatives