Skills Guide

Documentation Audit

VerifiedSafe

Audit and update documentation files to match actual repo state.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
7/23/2026
Claude Code
#documentation#audit#repo-maintenance#makefile#github

Recommended for

Claude CodeAuto documentationSecurity auditGit automationSecurity engineer

Automated summary

Audits a GitHub repository’s documentation files and fixes them so they match the actual repository state and make targets.

Strengths

  • Cross-checks documentation against directories, tools/*.tl files, Makefile/work.mk/reflect.mk targets, and GitHub Actions workflows.
  • Restricts edits to Markdown files in the repository root and docs/ directory.
  • Stages and commits each correction with a descriptive message.
  • Writes a final report listing changes, status, and remaining issues.

Limitations

  • Assumes a specific repository layout with o/repo, skills/, tools/*.tl, Makefile, work.mk, and reflect.mk.
  • Does not modify code, makefiles, or workflows even when inconsistencies are found outside the docs.
  • Deliberately conservative and may leave uncertain inaccuracies untouched.
When to use it

Use this skill when a repository already has AGENTS.md and docs/ and you need to verify that the documentation still matches existing files, make targets, and workflows.

When not to use it

Do not use it to write speculative new documentation or to audit a repository that lacks the structure and makefile conventions this skill expects.

Security analysis

Safe
Quality score85/100

The skill only audits and edits documentation files and commits those changes; it explicitly forbids modifying code, tool files, makefiles, or workflows, and contains no destructive, exfiltrating, obfuscated, or safety-disabling instructions.

No concerns found

How this analysis is made

Examples

Full docs audit
Audit AGENTS.md and docs/ in o/repo against the actual skills/ tools, Makefile, work.mk, reflect.mk, and .github/workflows. Fix any inaccuracies in the documentation files, commit each fix, and write o/docs/docs.md with the changes and status.
Check structure and make targets
Check whether the structure tree, tool lists, and make targets in docs/architecture.md and docs/work.md still match the repository. Update only the Markdown documentation files and report any remaining issues.
Conservative documentation sync
Review the docs in o/repo for outdated phase descriptions and setup permissions, but be conservative: only fix clear mismatches and do not add documentation for anything that does not already exist.

name: docs description: Audit and update documentation files to match actual repo state.

Docs

You are auditing documentation in a GitHub repository and fixing any inaccuracies.

Environment

  • The target repo is cloned at o/repo/. You have read and write access.
  • Only modify documentation files: AGENTS.md and files under docs/.

Instructions

  1. Read all documentation files: AGENTS.md, docs/architecture.md, docs/work.md, docs/reflect.md, docs/conventions.md, and any other .md files in docs/.
  2. Read the actual repo structure to compare against docs: a. List skills/ directories and their tools/*.tl files. b. Read Makefile for targets and help text. c. Read work.mk for work loop targets and standalone targets. d. Read reflect.mk for reflect loop targets. e. Read .github/workflows/ for workflow definitions.
  3. For each doc file, check:
    • structure tree: does the tree in AGENTS.md match actual directories, files, and tool lists?
    • usage examples: do make targets listed in usage sections actually exist?
    • tool lists: do parenthetical tool lists match actual .tl files in each skill's tools/ directory?
    • phase descriptions: do phase lists (e.g. fetch → analyze → publish) match the actual make targets?
    • permissions and setup: does setup info match current workflow files?
  4. Fix any inaccuracies by editing the doc files directly.
  5. Stage and commit each fix with a descriptive message.

Constraints

  • Only modify .md files in the repo root or docs/ directory.
  • Do not modify code, tool files, makefiles, or workflows.
  • Do not add speculative documentation — only document what exists.
  • Be conservative: if unsure whether something is wrong, leave it alone.

Output

Write o/docs/docs.md:

# Docs

## Changes
<list of files changed and what was fixed>

## Status
<success|no-changes>

## Notes
<any remaining issues noticed but not fixed>

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/documentation-audit-mrx3xy4k/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/documentation-audit-mrx3xy4k' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-audit-mrx3xy4k/download' --output '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md.part' && mv '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md.part' '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md' && test -s '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs' && cp -R '.skill-downloads/documentation-audit-mrx3xy4k' '.claude/skills/docs'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/documentation-audit-mrx3xy4k'

openskills read 'documentation-audit-mrx3xy4k'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/documentation-audit-mrx3xy4k/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot