Skip to content
TrustedSkillsbeta
Back to all skills

Review Doc Consistency

Checked
heyvhuang·vlatest·writing·MIT

Ensures documents align with established guidelines, flagging inconsistencies in style, tone, and factual accuracy.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add heyvhuang/ship-faster --skill review-doc-consistency -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

heyvhuang

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned heyvhuang/ship-faster at 64047d24e0.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
64047d24e0
Manifest
skills/review-doc-consistency/SKILL.md
Scanned
6 files, 682 lines
Copies in repo
2 — all of them scanned
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill, Review Doc Consistency, systematically identifies inconsistencies between documentation and code within a project's README and documentation files (located in docs/**/*.md). It prioritizes discrepancies where documentation conflicts with source code, configuration files, or contract definitions (like OpenAPI/proto/schema/TS types), treating these as the single source of truth. The skill aims to output at least 30 identified issues, categorized by severity, and provides evidence for each finding.

When to use it

  • Maintaining accurate API documentation: Ensure your API documentation accurately reflects the current code implementation.
  • Validating development guides: Confirm that instructions in development guides are consistent with how the code actually works.
  • Improving security posture: Identify and address any inconsistencies related to security configurations documented versus implemented.
  • Standardizing project documentation: Enforce consistency across all documents, including READMEs and API references.

Key capabilities

  • Document Scanning: Scans README.md (root directory) and files within the docs/**/*.md directories, as well as contract files (OpenAPI/proto/GraphQL schema/TS types).
  • Code-Documentation Comparison: Compares documentation claims with corresponding code implementations to identify mismatches in behavior, default values, or missing information.
  • Severity Level Assignment: Categorizes issues based on severity levels: P0 (Security/Serious Misleading), P1 (Core Functionality Inconsistency), P2 (Incomplete Examples/Naming), P3 (Minor Wording Issues), and Pending Evidence.
  • Evidence-Based Reporting: Provides specific code or configuration file locations as evidence for each identified inconsistency.
  • Output Formatting: Generates a doc-consistency.md report file and a structured doc-consistency.json issue list.

Example prompts

  • "Review the documentation for inconsistencies with the codebase."
  • "Check all API documentation against the OpenAPI schema."
  • "Find any discrepancies between the README and the current code implementation."

Tips & gotchas

  • Contracts are authoritative: Remember that contract files (OpenAPI, proto, etc.) take precedence over documentation.
  • Prioritization: Security-related inconsistencies (P0 severity) will be prioritized.
  • Parallel Execution: The skill is designed to be run in parallel across different document types or modules for faster review times.