Question 1

How do I review my docs against writing style guidelines?

Accepted Answer

Provide a file path or glob pattern as the argument, and the Skill fetches the latest Writing Guidelines, reads your files, and checks them against every rule. Findings are reported in a terse file:line format.

Question 2

What writing guidelines does this Skill check against?

Accepted Answer

It fetches the 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 version.

Question 3

Can I review multiple documentation files at once?

Accepted Answer

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

Question 4

Does the writing guidelines review require internet access?

Accepted Answer

Yes, the Skill uses WebFetch to retrieve the latest guidelines from a raw GitHub URL before each review. Without network access, it cannot load the rules and perform the check.

Question 5

What output format does the docs review produce?

Accepted Answer

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

writing-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

Frequently Asked Questions about writing-guidelines

Related Skills

markdown-docs

good-docs-audit

blog-proofreading

vale