reviewing-developer-guide

Reviews developer guides against a 14-condition adoptability and accuracy bar, emitting an approve or revise verdict.

1|1|Updated May 24, 2026
One-click install
npx skills add https://github.com/bm629/agent-skills --skill reviewing-developer-guide-bm629
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reviewing-developer-guide
Source: https://github.com/bm629/agent-skills/tree/main/skills/reviewing-developer-guide
Command: npx skills add https://github.com/bm629/agent-skills --skill reviewing-developer-guide-bm629

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Developer guides for SDKs, CLIs, frameworks, and API platforms often ship with fabricated endpoints, unverifiable getting-started steps, or missing integration recipes, leaving developers unable to adopt the tool. This Skill acts as an independent acceptance gate that judges a finished or amended developer guide against a fixed 14-condition bar and returns a machine-parseable verdict with actionable findings. ## Core Features & Use Cases - 14-condition adoptability + accuracy checklist: Judges goal-organization, verifiable first success, concepts-before-recipes, scenario coverage, Diataxis mode separation, api-reference linking, sample accuracy, versioning, troubleshooting, and findability. - Amend-mode delta review: When a change request and changed upstreams are handed in, reviews only the delta plus a staleness sweep for samples calling removed or renamed capabilities. - Machine-parseable verdict output: Emits exactly VERDICT: approve or VERDICT: revise plus actionable findings naming the failed condition, location, and concrete fix. - Use Case: After authoring a developer guide for a new SDK, run this Skill with the guide plus the feature-spec and api-reference to decide whether it can ship to integrating developers or needs a bounded revision pass. ## Quick Start Use reviewing-developer-guide to judge the finished developer guide at docs/developer-guide.md against the handed-in feature-spec and api-reference, and emit the verdict with findings.

Frequently Asked Questions about reviewing-developer-guide

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

FAQPage Schema
How do I review a developer guide before shipping it?

Hand the finished guide plus its upstreams (feature-spec, api-reference) to this Skill. It reads the guide end to end, judges it against 14 adoptability and accuracy conditions, and emits VERDICT: approve or VERDICT: revise with actionable findings for each gap.

What does the developer guide review checklist check?

It checks 14 conditions: goal-organization, a verifiable first success with env-var credentials, concepts before recipes, scenario coverage, a separate end-to-end tutorial, grounded best-practices, Diataxis mode separation, linking rather than duplicating the api-reference, sample accuracy, versioning and migration, no fabrication, delta-scoped amends, troubleshooting, and findability.

Can this Skill review an amended developer guide after a tool update?

Yes. When a change request and changed upstreams are handed in, it activates amend mode: it reviews only the delta, runs a staleness sweep for samples calling removed or renamed capabilities, and checks the version bump and changelog row, without re-reviewing untouched content.

When should I not use this developer guide review gate?

Do not use it to author or fix a guide (use authoring-developer-guide), to review end-user product guides, api-reference catalogs, or engineering design documents. Those are distinct documents with distinct review bars and separate skills.

Does the reviewer fail thin guides for small tools?

No. The bar is proportional to the product archetype: a thin single-purpose CLI legitimately collapses sections it does not need. Only the verifiable first success and no-fabrication conditions bind at any size, and brevity alone is never a revise trigger.