Docs Review
Review of documentation correctness in an open-source pull request — treating docs as unexecuted code and verifying them by running them. Use when a diff touches README files, docstrings, tutorials, quickstarts, API reference, migration guides, changelogs, or example projects, and equally when a code diff renames a symbol, changes a default, adds a required argument, or alters a config key in a way that silently invalidates documentation elsewhere in the repo. Verifies samples in a clean environment, walks quickstarts from an empty state, greps the docs tree for every symbol the diff touched,
Install
/plugin marketplace add priyank766/OpenSource-SKILLThe repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.
npx skills add priyank766/OpenSource-SKILL --skill docs-reviewgit clone --depth 1 https://github.com/priyank766/OpenSource-SKILL.git /tmp/OpenSource-SKILL
mkdir -p ~/.claude/skills
cp -r /tmp/OpenSource-SKILL/skills/docs-review ~/.claude/skills/docs-reviewPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# Documentation Review A specialised lens on [`pr-review`](https://github.com/priyank766/OpenSource-SKILL/blob/main/skills/pr-review/SKILL.md), for diffs that change documentation and for diffs that break it without touching it. **Read first:** [`DETECTION-PLAYBOOK.md`](references/DETECTION-PLAYBOOK.md) · [`QUALITY-FILTER.md`](references/QUALITY-FILTER.md) · [`REVIEW-VOICE.md`](references/REVIEW-VOICE.md) > **Where the time goes.** Finding the flaw is the review. The playbook above is the > general flaw-hunting procedure; this file is the domain-specific lens on top of it. > Scoring and writing the comment are the last ten minutes, not the work. **Severity floor: 8.5** — higher than the suite default of 8.0. Docs attract more low-value opinion per line than any other part of a codebase: everyone can read prose, so everyone has a view on it, and a review thread fills with comma placement while the broken `pip install` line three paragraphs down goes unmentioned. Raising the floor is the only defence. At 8.5, a finding ships only if it is a correctness error or something that stops a reader completing the task. --- ## The governing rule **Documentation is code that is never executed, so it rots silently. The job is to execute it.** Nothing in CI runs the README. No test fails when a tutorial's second command starts erroring. The drift is invisible until a user hits it, and by then it has cost them an hour and cost the
Details
- Skill name
docs-review- Repository
- priyank766/OpenSource-SKILL
- Path
skills/docs-review/SKILL.md- License
- Apache-2.0
- Repo updated
- 6 August 2026
- Listed in
- karanb192/awesome-claude-skills
FAQ
What does the Docs Review skill do?
Review of documentation correctness in an open-source pull request — treating docs as unexecuted code and verifying them by running them. Use when a diff touches README files, docstrings, tutorials, quickstarts, API reference, migration guides, changelogs, or example projects, and equally when a code diff renames a symbol, changes a default, adds a required argument, or alters a config key in a way that silently invalidates documentation elsewhere in the repo. Verifies samples in a clean environment, walks quickstarts from an empty state, greps the docs tree for every symbol the diff touched,
How do I install the Docs Review skill?
Claude Code plugin: /plugin marketplace add priyank766/OpenSource-SKILL. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Docs Review popular?
It lives in priyank766/OpenSource-SKILL, which has 1 GitHub stars and 0 forks, and is included in 1 curated skill list.
Related skills
API Compat Review
1priyank766/OpenSource-SKILL
Backward-compatibility review of changes to a project's public surface. Use when a diff changes exported function or type signatures, renames or removes public symbols, changes a default value, alters config keys, environment variables, or CLI flags, modifies an HTTP or wire format, migrates a database schema, changes exception or error types, touches plugin or extension hooks, or whenever a PR proposes a major-version bump. Establishes what the project actually promises, diffs the public surface between base and head with language-native tooling, classifies each change against a breaking-chan
Contributor Experience Review
1priyank766/OpenSource-SKILL
Review of a first-time or early-stage contributor's pull request, where the technical bar stays fixed but the sequencing, batching, and supplied context change. Use when GitHub labels the author a first-time contributor, when the PR comes from a newcomer to this repo, when it arrives via Hacktoberfest, GSoC, Outreachy, or a good-first-issue, when the change is technically close but procedurally messy (missing DCO, wrong base branch, unsigned commits, failing lint), or when the PR must be declined and the decline needs to not cost the project a future contributor. Applies a raised severity floo
Dependency Review
1priyank766/OpenSource-SKILL
Supply-chain review of dependency and CI changes in an open-source pull request. Use when a PR adds or bumps a dependency, changes a lockfile, introduces a build or postinstall script, edits a GitHub Actions workflow, changes a container base image, or when a bot-generated dependency bump needs human judgement before merge. Covers install-time code execution, package-identity and typosquat checks, artifact provenance, transitive footprint, license class, and workflow privilege changes. Ecosystem-agnostic — npm, PyPI, Go, Cargo, RubyGems, Composer, containers. Do NOT use for routine patch bumps
Avoid AI Writing
5lucaspmarie-a11y/claude-skills-vault
Audit and rewrite content to remove 21 categories of AI writing patterns with a 43-entry replacement table
Internal Comms
anthropics/skills
A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).
Blog Writing Guide
5lucaspmarie-a11y/claude-skills-vault
This skill enforces Sentry's blog writing standards across every post — whether you're helping an engineer write their first blog post or a marketer draft a product announcement.
Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.