check-docs

Validate docs/ structure and ADR numbering with Python scripts.

Updated Mar 8, 2026
One-click install
npx skills add https://github.com/aifuun/u-safe-archive --skill check-docs-aifuun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/aifuun/u-safe-archive/tree/main/.claude/skills/check-docs
Command: npx skills add https://github.com/aifuun/u-safe-archive --skill check-docs-aifuun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Projects often drift from documentation standards, leaving missing files, misnamed documents, and non-sequential ADRs that break onboarding, CI checks, and release readiness; this Skill automates the detection and reporting of those issues so teams can enforce consistency before release.

Core Features & Use Cases

  • Structure Validation: Verifies required docs directories including profile-specific folders and reports missing directories.
  • File Validation & Naming: Checks presence of mandatory documents, enforces UPPERCASE core docs and kebab-case auxiliary docs, and suggests renames.
  • ADR Continuity: Detects ADR numbering gaps and missing ADR index entries.
  • Scoring & CI Integration: Produces a 0–100 compliance score, human-readable and JSON outputs, and exit codes suitable for CI gates.
  • Auto-fix Suggestions: Generates actionable fixes and can call /init-docs or provide rename/mkdir suggestions to restore compliance.
  • Use Cases: Pre-release verification, CI documentation gates, onboarding audits, and automating repo cleanup before handoffs.

Quick Start

Check the project's documentation structure for the tauri profile and return a JSON validation report.

Frequently Asked Questions about check-docs

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

FAQPage Schema
How do I validate project documentation structure and detect missing required files?

You validate project documentation structure by executing a Python script that checks for missing directories, required files, naming violations, and ADR numbering gaps, producing a human-readable or JSON report with a 0-100 compliance score.

How do I check for ADR numbering gaps and missing index entries in my docs?

To check for ADR numbering gaps, run the validation script against your docs directory. It detects non-sequential ADR numbering and missing index entries, then generates actionable auto-fix suggestions to restore continuity.

Can I use documentation validation as a CI gate for Tauri or Nextjs projects?

Yes, documentation validation supports profile-aware checks for Tauri, Tauri-AWS, and Nextjs-AWS projects. It outputs CI-friendly exit codes and a compliance score, allowing pipelines to block releases when standards are not met.

Do I need Python 3 to run documentation structure validation checks?

Yes, you need Python 3 installed to run documentation structure validation checks. The Skill executes a bundled Python script relying on Python 3 and the repository's shared config reader to generate reports and suggested fixes.

What is the best way to auto-fix missing documentation directories before a release?

The best way to auto-fix missing documentation directories is to run the validation script, which generates actionable mkdir and rename suggestions. It can call an initialization command to restore compliance for pre-release verification.

Why does my CI documentation gate fail with a low compliance score?

Your CI documentation gate fails because the validation script detected missing directories, mandatory files, naming violations, or ADR numbering gaps. It returns a non-zero exit code when the 0-100 compliance score falls below required standards.