sync-documentation

sync-documentation is a skill for Claude Code from tomzx/agents. It costs 78 tokens per session (3,448 once invoked), scanned A, original, MIT.

A documentation maintenance tool that compares the repository's code with its docs/ folder and finds outdated, missing, or broken documentation.

In plain words
What is it for?
Use it to check and update a project's user-facing documentation after code changes, then produce a report for issues that need human review.
Why use it?
It helps prevent documentation from falling behind when code changes. It identifies stale references, invalid examples, broken links, and incorrect navigation, and can apply safe mechanical fixes.

Skill for Claude Code

Written for Claude Code: argument-hint in frontmatter. Also seen: positional $N argument.

Good fit Use it to check and update a project's user-facing documentation after code changes, then produce a report for issues that need human review.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/tomzx/agents/sync-documentation
View source ↗ tomzx/agents
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add tomzx/agents --skill sync-documentation
Clone the repo
git clone --depth 1 https://github.com/tomzx/agents

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for sync-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/tomzx/agents/sync-documentation/github.svg)](https://agentmods.dev/skills/tomzx/agents/sync-documentation)
Your own site
<a href="https://agentmods.dev/skills/tomzx/agents/sync-documentation"><img src="https://agentmods.dev/badge/skills/tomzx/agents/sync-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for sync-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/tomzx/agents/sync-documentation"><img src="https://agentmods.dev/badge/skills/tomzx/agents/sync-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 78 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,448 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00078 $0.03448
Opus 5 $0.00039 $0.01724
Sonnet 5 $0.00016 $0.00690
Haiku 4.5 $0.00008 $0.00345

Measured 7d ago against content hash 115e66a910ff, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

sync-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 7d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/sync-documentation/SKILL.md · 297 lines

How it starts

The opening of the file, as written. The whole thing — 297 lines — stays where its author put it; the contents beside it link to each section on GitHub.

TODAY=!date +%Y-%m-%d

Sync Documentation

Reads the codebase and reconciles the docs/ directory against it. On every run it detects drift between code and documentation, classifies each drift item, and (with --fix) applies the updates that are safe to make mechanically. Unlike sync-sdlc (which reconciles .sdlc/ artifacts), this skill reconciles the user-facing docs/ tree: the prose people actually read.

The Core Problem This Solves

Code changes constantly; documentation changes when someone remembers to update it. The result is docs that reference functions renamed three releases ago, CLI flags that no longer exist, code examples that fail to run, and nav entries pointing at deleted files. /find-documentation-gaps reports what is missing. This skill goes further: it detects every flavor of drift (stale, missing, broken, outdated), fixes the mechanical ones automatically, and hands the rest to a human as a prioritized report.

Prerequisites

  • Working directory is the root of the repository
  • A docs/ directory exists (or the $1 path points at one). If neither exists, report that there is nothing to sync and suggest /setup-docs-site.
  • Read access to the source tree and docs/
  • Optional: a docs build tool installed to verify the build (mkdocs, sphinx-build, npm)
  • git repository with commit history (used to scope drift to recent changes when --fix is off)

Drift Scenarios This Skill Detects

Drift Root Cause Fixable With --fix
Doc references a function/class/symbol that no longer exists Code renamed or removed yes (rename or flag)
Code example uses a renamed or removed API Example not updated with the code yes
Doc references a CLI flag or subcommand that no longer exists CLI changed yes
Doc references a config key or env var that no longer exists Config changed yes
Public API, CLI command, or endpoint has no doc at all New code added without docs no (needs writing)
Function signature in code (params, defaults) differs from the doc Signature changed yes
mkdocs.yml nav lists a file that does not exist Doc deleted, nav not updated yes
Doc file exists but is not referenced in nav Doc added, nav not updated yes
Internal doc link points to a moved or deleted page Refactor of doc structure yes
External link is broken (404) Upstream moved or vanished no (report only)
Doc duplicates information now stale vs README.md / CHANGELOG.md Single source of truth broken no (report)
Docs build fails Any of the above, or config error no (report)

Read the full file on GitHub · 297 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 7d ago First seen · 297 lines · 78 tokens per session scan A 115e66a910ff

Subscribe to this mod's changes

sync-documentation is a skill published in the GitHub repository tomzx/agents (6 stars, last pushed 2d ago), licensed MIT. It adds 78 tokens to every session and 3,448 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens