Documentation & refactoring · Audit

Documentation Sync Audit

Audit repository documentation against authoritative code, configuration, schemas, commands, runtime behavior, and generated references.

MCP library 1.6.1 · Instruction library 1.6.1 · English technical instructions

← Back to search

Use this workflow

Connect Vibe Coding Library to a coding agent that supports MCP over Streamable HTTP. Choose Other / MCP agent for a neutral prompt, or a ready-made Codex or Claude Code invocation. Add your task details below.

Operation

Inspect the selected behavior and report evidence-backed defects; do not change product code.

Goal and scope

Audit repository documentation against authoritative code, configuration, schemas, commands, runtime behavior, and generated references.

Domain invariants

  • Documentation identifies its governing source. Distinguish accepted requirements from observed implementation; a mismatch may be a code defect rather than stale prose.
  • Commands, paths, config keys, API/schema examples, lifecycle, permissions, and failure behavior match the repository.
  • Generated docs/maps are rebuilt by repository-native tooling and distinguish generated from hand-maintained content.
  • Runbooks include observable trigger, safe action, rollback/recovery, ownership, and environment assumptions.

Audit method

  1. Trace each selected statement/example to code, tests, config, schema, script, or runtime evidence.
  2. Check stale commands, dead paths, renamed symbols, incompatible examples, missing failure/rollback, and duplicated truth.
  3. Inspect generation sources and whether manual edits would be overwritten.
  4. Separate factual drift from broader editorial improvement.

Handoff

For each discrepancy, provide the selected statement/example, expected contract, actual source and which maintained document or generator owns the repair. Distinguish stale prose, a broken generated pipeline and an implementation that violates accepted requirements. Pass supported documentation repairs to Improve Documentation Sync only when edits are requested; otherwise return the findings.

Workflow ID: documentation-sync-audit · View the versioned source · Shared workflow and authority rules