Agent skill

Docs Audit

by strands-agents in strands-agents/harness-sdk

Assess a published or in-progress documentation page for quality, accuracy, and voice compliance.

Apache-2.0Auto-check passedDevelopment

Install Docs Audit

skills CLI
$ npx skills add strands-agents/harness-sdk --skill docs-audit -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install strands-agents/harness-sdk docs-audit --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/strands-agents/harness-sdk.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-audit .claude/skills/docs-audit && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-audit
GitHub stars
8.7k
Token cost
~1.5k tokens
SKILL.md length
655 words
Files
1
Skills in repo
14
Repo updated
First seen
Licence
Apache-2.0

At a glance

Assess a published or in-progress documentation page for quality, accuracy, and voice compliance.

  • Works in 5 steps: Fetch and classify → Voice stack review → Accuracy check → …
  • Audit this page
  • SKILL.md covers When to Use, Inputs, Process and Output Format, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Docs Audit is an agent skill from strands-agents/harness-sdk. Assess a published or in-progress documentation page for quality, accuracy, and voice compliance. Use before rewriting a page, during periodic health checks, when community signals point to confusion, or when comparing against competitor docs. Also triggers on "audit this page", "assess the docs", "what's wrong with this page", "check docs quality", "review this doc page".

Its SKILL.md is about 1.5k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development. The repository describes itself as: Build an agent harness and control it end-to-end. Open-source SDK for production AI agents in Python & TypeScript - any model, any cloud. The licence is Apache-2.0.

When your agent uses it

  • Audit this page
  • Assess the docs
  • Whats wrong with this page
  • Check docs quality

Example prompts

  • “audit this page”
  • “assess the docs”
  • “s wrong with this page”
  • “/docs-audit”

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Fetch and classify
  2. Voice stack review
  3. Accuracy check
  4. AI-readability check
  5. Competitive comparison (optional)

What it can do on your machine

Read from SKILL.md and the folder at commit e519d67. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Audit loads about 1.5k tokens when it runs. Until then it costs about 97 tokens; SKILL.md has 655 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~97
When it runs · the whole SKILL.md, loaded when a task matches
~1.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from strands-agents/harness-sdk at commit e519d67, republished under its Apache-2.0 licence (© strands-agents). 655 words, ~1,482 tokens.

Download SKILL.mdSave it as .claude/skills/docs-audit/SKILL.md (or your agent's skills folder).
name
docs-audit
description
Assess a published or in-progress documentation page for quality, accuracy, and voice compliance. Use before rewriting a page, during periodic health checks, when community signals point to confusion, or when comparing against competitor docs. Also triggers on "audit this page", "assess the docs", "what's wrong with this page", "check docs quality", "review this doc page".

Documentation Audit

Assess an existing documentation page. Produces a structured assessment with specific improvement recommendations.

How this differs from docs-reviewer: The docs-reviewer is a voice/style gate for drafts in progress (runs at the end of docs-writer). The docs-audit is an assessment tool for published pages: it checks accuracy against SDK source, identifies content gaps, and optionally compares against competitor docs. Use docs-audit to decide what needs work; use docs-reviewer to verify that a draft is ready to ship.

When to Use

  • Before rewriting a doc page (understand current state first)
  • When community signals point to confusion around a topic
  • During periodic docs health checks
  • When comparing Strands docs to competitor docs on the same topic

Inputs

  • Target page: File path in site/src/content/docs/ or published URL
  • Content type: If known. If not, classify it first.
  • Context (optional): Community signals, GitHub issues, or specific concerns

Process

Step 1: Fetch and classify

Read the source file from site/src/content/docs/ in this repo. If you need the published version and have web access, fetch from strandsagents.com.

Classify the content type (tutorial, howto, reference, explanation, mixed). Note: "mixed" is itself a finding. Pages that mix types are the most common structural problem.

Step 2: Voice stack review

Walk through each layer of the voice stack defined in ../../references/voice-guide.md against this page:

  1. Structure — Does each section answer exactly one question? Are there sections that mix concerns?
  2. Framing — Do section openings lead with the developer's goal, or with API descriptions?
  3. Register — Does the tone match the content type? Flag tutorial/reference mismatches.
  4. Hard constraints — Check for banned phrases, passive voice, hedging, terminology violations.
  5. Authenticity — Does the page have structural variety and visible editorial choices?
Step 3: Accuracy check

Follow the verification procedure in ../../references/code-verification.md. Check imports, parameter names, types, defaults, and method signatures against SDK source.

The SDK source is the source of truth. Where the docs page contradicts the source, the docs are wrong by definition — flag the inconsistency under Accuracy Issues with the file/line in the SDK that the docs disagree with. Never reconcile in the other direction (do not "update" the source to match a docs claim).

Specific checks:

  • Are code examples using current API signatures?
  • Do import statements reference current package names and module paths?
  • Are parameter names and types correct against the latest SDK source?
  • Are any documented features deprecated or removed?
  • Are internal cross-reference links working?
  • Snippet file conventions: TypeScript code must live in sibling .ts snippet files (included via --8<--), never inlined in MDX. Each TypeScript fence should include both an imports snippet (_imports.ts) and a body snippet so the rendered block is self-contained. Verify that each --8<-- "path:region" directive references a real file with a matching [start:region]/[end:region] pair. Flag inlined TypeScript or missing imports includes as structural issues.
Show full SKILL.md (193 more words)Show less
Step 4: AI-readability check
  • Is the page self-contained? (Could an AI assistant use this page alone?)
  • Is essential context at the top?
  • Is inline code properly formatted with backticks?
  • Is terminology consistent with the terminology lock?
  • Are language-specific identifiers in shared prose using the <Syntax> component rather than being spelled out manually with language labels?
Step 5: Competitive comparison (optional)

When to run. Only on conceptual or how-to pages covering tasks other agent frameworks also address (agents, tools, hooks, sessions, streaming, multi-agent, structured output). Skip for Strands-internal architecture, reference/API, and governance pages.

How.

  1. Fetch 1–3 relevant comparator pages via web access (cite URL + access date in the report).
  2. Compare on three axes — coverage, depth, voice — one observation per axis.
  3. Output one-line gaps under ### Competitive Notes: "Add [topic] — comparators X, Y cover it; we don't."

Don't imitate voice; only adopt structure or coverage. If a comparator does something we shouldn't (hype, non-deterministic shown as deterministic), note it so future audits don't drift toward it.

Output Format

markdown
## Docs Audit: [Page Title]

**URL:** [published URL or file path]
**Content type:** [classified type]
**Overall verdict:** [Strong / Needs work / Significant gaps]

### Voice Stack Assessment

| Layer | Score | Key Finding |
|-------|-------|-------------|
| Structure | /warning/x | [one-line finding] |
| Framing | /warning/x | [one-line finding] |
| Register | /warning/x | [one-line finding] |
| Constraints | /warning/x | [count of violations] |
| Authenticity | /warning/x | [one-line finding] |

### Accuracy Issues
- [list specific inaccuracies found, or "None detected"]

### AI-Readability Issues
- [list specific issues, or "Passes all checks"]

### Recommended Actions
1. [Highest priority fix]
2. [Second priority]
3. [Third priority]

### Competitive Notes (if checked)
- [observations from competitor comparison]

What This Skill Does NOT Do

  • Does not rewrite the page (use docs-writer for that)
  • Does not commit changes
  • Does not modify the docs repo

© strands-agents, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-audit of strands-agents/harness-sdk.

Open the folder on GitHubat commit e519d67

Compare with similar skills

Docs Audit next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Audit compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Audit this skillstrands-agents/harness-sdk8.7k—~1.5kAutomated safety check: PassApache-2.0
Vercel Composition Patternssupabase/supabase111k59 repos~726Automated safety check: PassMIT
Finishing a Development Branchobra/superpowers296k5 repos~1.9kAutomated safety check: PassMIT
Typescript Advanced Typesrolling-scopes/rsschool-app10k25 repos~4.2kAutomated safety check: PassMPL-2.0
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0
Code Review ChecklistshareAI-lab/learn-claude-code78k5 repos~1.1kAutomated safety check: PassMIT

Similar skills

  • Official

    React composition patterns that scale. An agent skill from supabase/supabase.

    111k GitHub starsUsed in 59 repos~726 tokens
    DevelopmentAuto-check passed
  • Walks the last step of a branch: confirm tests pass, detect the git environment, ask how to integrate, carry out your choice and clean up the worktree.

    296k GitHub starsUsed in 5 repos~1.9k tokens
    DevelopmentAuto-check passed
  • Typescript Advanced Types

    rolling-scopes/rsschool-app

    Master TypeScript's advanced type system including generics, conditional types, mapped types, template literals, and utility types for building type-safe applications.

    10k GitHub starsUsed in 25 repos~4.2k tokens
    DevelopmentAuto-check passed
  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Code Review Checklist

    shareAI-lab/learn-claude-code

    Reviews code against a five-part checklist covering security, correctness, performance, maintainability and testing, and reports findings in a fixed format.

    78k GitHub starsUsed in 5 repos~1.1k tokens
    DevelopmentAuto-check passed
  • Greploop

    onyx-dot-app/onyx

    Iteratively improves a PR (GitHub), MR (GitLab), or shelved changelist (Perforce) until Greptile gives it a 5/5 confidence score with zero unresolved comments.

    32k GitHub starsUsed in 4 repos~3.3k tokens
    DevelopmentAuto-check passed

More from strands-agents/harness-sdk

All 14 skills in this repo
  • Docs Planner

    strands-agents/harness-sdk

    Identify documentation gaps and prioritize the docs backlog.

    8.7k GitHub stars~821 tokensUpdated today
    Auto-check passed
  • Docs Reviewer

    strands-agents/harness-sdk

    Review documentation drafts for voice consistency, structure, and terminology before PR submission.

    8.7k GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • Docs Writer

    strands-agents/harness-sdk

    Draft or rewrite Strands Agents documentation pages. An agent skill from strands-agents/harness-sdk.

    8.7k GitHub stars~2k tokensUpdated today
    Auto-check passed
  • PR Create

    strands-agents/harness-sdk

    Creates a GitHub pull request using the gh CLI. An agent skill from strands-agents/harness-sdk.

    8.7k GitHub stars~593 tokensUpdated today
    Auto-check passed
  • PR Feedback

    strands-agents/harness-sdk

    Fetches PR review feedback and inline comments, categorizes them, and presents options to the user.

    8.7k GitHub stars~675 tokensUpdated today
    Auto-check passed
  • PR Writer

    strands-agents/harness-sdk

    Generates pull request titles and descriptions. An agent skill from strands-agents/harness-sdk.

    8.7k GitHub stars~2.1k tokensUpdated today
    Auto-check passed

Categories

Questions about Docs Audit

What does Docs Audit do?

Assess a published or in-progress documentation page for quality, accuracy, and voice compliance. Docs Audit is an agent skill from strands-agents/harness-sdk. Assess a published or in-progress documentation page for quality, accuracy, and voice compliance.

When should I use Docs Audit?

Docs Audit fits situations like: audit this page; assess the docs; whats wrong with this page; check docs quality.

How do I install Docs Audit in Claude Code?

Run `npx skills add strands-agents/harness-sdk --skill docs-audit -a claude-code`. Or copy the skill folder (.agents/skills/docs-audit in strands-agents/harness-sdk) into .claude/skills/docs-audit in your project. Claude Code loads it when a task matches its description.

How do I install Docs Audit in Codex?

Run `npx skills add strands-agents/harness-sdk --skill docs-audit -a codex`. Or copy the skill folder (.agents/skills/docs-audit in strands-agents/harness-sdk) into .agents/skills/docs-audit in your project. Codex loads it when a task matches its description.

Can I use Docs Audit in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add strands-agents/harness-sdk --skill docs-audit -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-audit, .gemini/skills/docs-audit, .github/skills/docs-audit and .opencode/skills/docs-audit in your project.

What does Docs Audit need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Audit is instructions for the agent only.

Does Docs Audit access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Audit safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Audit use?

Docs Audit is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Audit use?

About 1.5k tokens (SKILL.md is roughly 5.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Audit?

Skills that share tags, products or a category with Docs Audit: Vercel Composition Patterns (supabase/supabase, 111k stars), Finishing a Development Branch (obra/superpowers, 296k stars), Typescript Advanced Types (rolling-scopes/rsschool-app, 10k stars) and PR Babysitter (openinterpreter/openinterpreter, 69k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Audit?

strands-agents (a GitHub organization) maintains it in strands-agents/harness-sdk, which has 8,731 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on October 7, 2026.

Source: strands-agents/harness-sdk on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.