# Validate Documentation Quality

Documentation can become incomplete, inconsistent, or outdated as projects change. This skill audits Markdown docs and returns prioritized fixes.

## Install

```bash
npx skillstore add c0ntr0lledcha0s/docs-validator
```

## Metadata

- - Slug: c0ntr0lledcha0s-docs-validator
- - Version: 1.0.0
- - Author: C0ntr0lledCha0s
- - GitHub username: C0ntr0lledCha0s
- - License: MIT
- - Repository: https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/docs-validator
- - Ref: main
- - Supported tools: Claude, Codex, Claude Code
- - Risk level: medium
- - Risk factors: external\_commands, network, filesystem
- - Quality score: 50
- - Quality tier: warning
- - Public page: https://skillstore.pages.dev/skills/c0ntr0lledcha0s-docs-validator
- - Manifest: https://skillstore.pages.dev/api/skills/c0ntr0lledcha0s-docs-validator/manifest

## Capabilities

- Checks whether expected module README files and guide sections are present.
- Reviews Markdown structure, header hierarchy, list formatting, tables, and code block language labels.
- Identifies internal and external links that need validation or repair.
- Compares examples, paths, terminology, and status notes for consistency.
- Produces prioritized documentation reports with issue locations and suggested fixes.
- Tracks coverage metrics for modules, guides, commands, skills, agents, and hooks.

## Use Cases

- Prepare Release Documentation: Run a full audit before release to find missing guides, stale status notes, and broken references.
- Improve Contributor Onboarding: Check whether setup, contributing, and troubleshooting content is complete and easy to follow.
- Review Module Coverage: Find modules that lack README files, examples, schema references, or clear usage instructions.

## Prompt Templates

### Quick Documentation Check

```
Validate the documentation in this repository. Focus on missing files, broken internal links, and the top three fixes.
```

### Check Link Health

```
Check documentation links. Separate internal links from external links, explain each issue, and suggest corrected targets.
```

### Audit Module Coverage

```
Audit module documentation coverage. List modules with README files, missing README files, weak examples, and priority order.
```

### Run Full Documentation Audit

```
Run a full documentation audit for coverage, accuracy, formatting, links, consistency, examples, and release readiness.
```

## Limitations

- The guidance is tailored to the Logseq Template Graph project structure.
- External link checks require network access and may be skipped in restricted environments.
- Shell examples should be reviewed before running on private or very large repositories.
- The skill cannot prove external facts are current without trusted source review.

## Best Practices

- Run quick checks during routine edits and full audits before releases.
- Review shell and network actions before allowing automated validation.
- Convert findings into small, prioritized documentation tasks with owners.

## Anti Patterns

- Do not treat sample scores or example reports as verified project results.
- Do not run external link checks when repository URLs or browsing activity are sensitive.
- Do not accept broad documentation rewrites without checking the specific evidence.

## Security Audit

- - Safe to publish: true
- - Audited at: 2026-06-28T19:00:59.374\+00:00
- - Summary: Static analysis found many shell, network, filesystem, and weak-crypto patterns in SKILL.md. Manual review shows the weak-crypto, path traversal, reconnaissance, and hardcoded URL matches are false positives from prose or sample report text. The remaining risk is legitimate but elevated because the skill instructs agents to run shell documentation scans, inspect workspace files, optionally test external URLs, and write reports.

## Stats

- - Views: 236
- - Downloads: 4
- - Favorites: 0
- - Popularity score: 0