Skip to content

techne:docsync

Compare documentation against the code it describes. Surface where the docs say one thing and the code says another, then correct it from current code: directly on a solo repo, after your confirmation on a team repo.

Part of techne: /plugin install techne@techne, then /techne:setup.

When to use

  • After a refactor that forgot to update the docs.
  • "Audit README.md for stale claims."
  • Before a release where outdated CLI commands or file paths would confuse users.
  • Checking that config keys, function signatures, and environment variables in docs still match.

Usage

Invoke by name in Claude Code:

/techne:docsync

Default scope is README.md plus every tracked file under docs/**/*.md. Narrow scope by naming a file:

/techne:docsync docs/getting-started.md

The skill extracts checkable claims (commands, paths, signatures, config keys, version numbers, env vars), verifies each against the source, and outputs a drift report grouped by file. It also lists user-visible surface no doc mentions: commands, flags, exit codes, config keys, env vars, files written on your machine, and a plugin's skills, MCP tools and hooks. A page that links the file holding the detail, such as a skill's SKILL.md, covers it. How it applies fixes depends on whose repo it is. On a solo repo (yours alone) it applies every fix the code or a cited web source settles, prose included, and lists what neither settles as unresolved rather than asking. On a team repo it asks: single-token swaps apply on confirmation, prose rewrites are shown as full before/after diffs first. See Solo and team repos.

See also

  • techne:docs-site: site mechanics (nav, deploy workflow, link integrity).
  • techne:deslop: slop in documentation prose unrelated to factual drift.
  • Conventions: ## repo section in .claude/skill-context.md for CLI entrypoint and runner module.

Full instructions

SKILL.md on GitHub holds the full instructions Claude follows for this skill.