common-doc-audit-k

Audit repository documentation for drift, broken links, and diagram accuracy.

1|Updated Jan 25, 2026
One-click install
npx skills add https://github.com/JSai23/claude-tooling --skill common-doc-audit-k
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: common-doc-audit-k
Source: https://github.com/JSai23/claude-tooling/tree/main/plugins/wf/skills/common-doc-audit-k
Command: npx skills add https://github.com/JSai23/claude-tooling --skill common-doc-audit-k

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Stale docs actively mislead and degrade trust. This skill provides a structured process to audit and maintain the health of repository documentation across code, diagrams, and living docs.

Core Features & Use Cases

  • Verifier: runs post-build to confirm that living docs reflect the latest build and that ARCHITECTURE.md is up to date.
  • Gardener: periodically audits the entire design-docs tree to catch drift, broken links, and missing sections.
  • Cross-link and plan health checks ensure diagrams, plans, and modules stay in sync with code.

Quick Start

Trigger a doc health audit after a build to verify living docs and ARCHITECTURE.md alignment.

Frequently Asked Questions about common-doc-audit-k

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit repository documentation to prevent drift and inaccuracies?

You can audit repository documentation by running a structured process that verifies living docs, ARCHITECTURE.md, and design-docs to catch drift, broken cross-links, and missing sections. This skill provides both post-build verifiers and periodic tree audits to sustain documentation health.

Why does stale documentation actively mislead teams, and how can I check for it?

Stale documentation misleads users and degrades trust when living docs no longer reflect the latest build or code changes. You can check for this by enforcing post-build verification to confirm ARCHITECTURE.md alignment and living doc freshness across the repository.

What's the best way to verify cross-link integrity and diagram accuracy in design-docs?

The best way to verify cross-link integrity and diagram accuracy is to periodically audit the entire design-docs tree using a dedicated gardener process that catches broken links and ensures diagrams, plans, and modules stay in sync with code.

Can I run a living doc freshness check automatically after a build?

Yes, you can run a living doc freshness check automatically after a build. The skill acts as a verifier post-build to confirm that living docs reflect the latest build output and that ARCHITECTURE.md is up to date.

When do I need to escalate documentation drift, and what remediation guidance is available?

You need to escalate documentation drift when periodic audits identify broken cross-links or outdated plan statuses. The skill provides clear escalation and remediation guidance to help correct diagram inaccuracies and living doc staleness across the full doc tree.