doc-audit

Solid

Audit Packmind end-user documentation (apps/doc/) for broken links, outdated CLI references, non-existent concepts, misleading information, and missing coverage. Produces a structured markdown report at project root. Use when docs may have drifted from the codebase, before a release, or on a regular cadence.

AI & Automation 287 stars 14 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 85/100

Stars 20%
82
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Audit Detect outdated, broken, or misleading documentation by cross-referencing MDX pages against the actual codebase. Produces a structured `doc-audit-report.md` at the project root. **This skill only detects issues — it does not fix them.** ## Phase 1: Build Ground Truth Before launching any sub-agents, build a concise ground truth summary by gathering these four data sources: 1. **Navigation structure** — Read `apps/doc/docs.json` and extract all navigation groups with their page lists 2. **CLI commands** — List files in `apps/cli/src/infra/commands/` to get current command files 3. **Domain packages** — List directories in `packages/` to get current package names 4. **Doc MDX files** — Glob `apps/doc/**/*.mdx` to get all actual pages on disk Compile these into a **ground truth summary** string formatted as: ``` ## Ground Truth ### Navigation Groups (from docs.json) - Getting Started: index, getting-started/gs-install-cloud, ... - Concepts: concepts/standards-management, ... [list all groups] ### CLI Commands (from apps/cli/src/infra/commands/) [list all *Command.ts and *Handler.ts files] ### Domain Packages (from packages/) [list all package directory names] ### MDX Files on Disk (from apps/doc/**/*.mdx) [list all .mdx file paths relative to apps/doc/] ### Current Date {today's date} ``` ## Phase 2: Launch Parallel Sub-Agents Launch **5 Explore sub-agents** in parallel (`subagent_type: Explore`), one per section group. Each agent receives: - ...

Details

Author
PackmindHub
Repository
PackmindHub/packmind
Created
8 months ago
Last Updated
today
Language
TypeScript
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

doc-audit

Audit project documentation against current code to find drift. Use when docs have fallen significantly behind code and you need a triage list before rewriting. Produces DOC_AUDIT.md with per-file verdicts (OK / minor / rewrite / delete). Does NOT auto-rewrite — user decides.

6 Updated yesterday
Jiahui-Gu
AI & Automation Listed

cli-audit-doc

Audit documentation quality with weighted scoring across 12 dimensions (Diataxis coverage, completeness, freshness, readability, examples, accessibility, CI testing). Detects doc anti-patterns (Wall of Text, The Lie, Jargon Soup). Use when reviewing doc quality, auditing documentation, checking for stale docs, or saying 'audit docs', 'doc quality', 'documentation review'. Invoke with an optional file or directory path.

4 Updated yesterday
Destynova2
Code & Development Listed

docs-auditor

Audits any developer documentation site across 33 checks in 7 categories and produces a scored report (out of 100) with Pass / Warn / Fail status per check. Use this skill whenever a user provides a docs URL and asks to audit it, review it, score it, check its quality, or evaluate it for AI discoverability, SEO, structure, content, or completeness. Also trigger when the user says "run a docs audit", "audit these docs", "check this documentation", "how good are the docs for X", or pastes a docs URL with any evaluative intent. Always use this skill — do not attempt a freeform docs review without following this structured workflow.

23 Updated today
Infrasity-Labs
Data & Documents Listed

docs-analyze

Run a full audit of your documentation in one command. Orchestrates 10 specialized analyses — content type, structure, style, audience, links, SEO, a11y, i18n, media, maintenance — and returns a single prioritized report you can hand to the writer. Works on one page, a folder, or the entire docs/ tree.

0 Updated 4 days ago
Docsbook-io
AI & Automation Solid

docs

Dispatch docs subagent to audit, generate, and validate documentation against the codebase.

321 Updated today
automagik-dev