docs-check

Analyze documentation across docs/ with a 5-axis quality check and generate a remediation report.

Updated Jan 30, 2026
Ready to run
npx skills add https://github.com/jon890/fos-blog --skill docs-check-jon890
๐Ÿ’ฌ Prompt for ChatGPT / Claude Chatโ–ผ
Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/jon890/fos-blog/tree/main/.claude/skills/docs-check
Command: npx skills add https://github.com/jon890/fos-blog --skill docs-check-jon890

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

๋ฌธ์„œ์˜ ํ’ˆ์งˆ ์ €ํ•˜์™€ ์˜์‚ฌ๊ฒฐ์ •์˜ ๋ถˆ์ผ์น˜๋ฅผ ๋ฐฉ์น˜ํ•˜๋Š” ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•ด, docs/ ์ „์ฒด๋ฅผ 5์ถ• ์ ๊ฒ€(๋ถ€ํŒจ/๊ณผ๋Œ€ํ™”/์ถ”๋ก ์„ฑ/์ค‘๋ณต/์ž๋ช…์„ฑ)์œผ๋กœ ๊ฒ€์‚ฌํ•˜๊ณ  ์‹ค์šฉ์ ์ธ ์ •๋ฆฌ ์ œ์•ˆ์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.

Core Features & Use Cases

  • ADR ์ค€์ˆ˜: ADR์— ๊ฒฐ์ •/๋งฅ๋ฝ/๊ทผ๊ฑฐ๊ฐ€ ํฌํ•จ๋˜๋„๋ก ๊ฒ€์ฆํ•˜๊ณ  ๊ด€๋ จ ์ฐธ์กฐ๋ฅผ ๊ฐ„์†Œํ™”ํ•ฉ๋‹ˆ๋‹ค.
  • ๋ฌธ์„œ ์œ„์ƒ ๊ด€๋ฆฌ: ์ฝ”๋“œ์™€ ๋ฌธ์„œ ๊ฐ„์˜ ๋ถˆ์ผ์น˜๋ฅผ ํƒ์ง€ํ•˜๊ณ  ๊ตฌ์‹ ํŒŒ์ผ ๊ฒฝ๋กœ๋ฅผ ๊ฒฝ๊ณ ํ•ฉ๋‹ˆ๋‹ค.
  • ํ†ตํ•ฉ ๋ฆฌํฌํŠธ ์ƒ์„ฑ: ๊ฐ„๊ฒฐํ•œ ๊ฐœ์„  ์ œ์•ˆ์„ ํฌํ•จํ•œ ์ •๋ฆฌ ๋ฆฌํฌํŠธ๋ฅผ ์‚ฐ์ถœํ•ฉ๋‹ˆ๋‹ค.

Quick Start

Run the docs-check task to scan all docs and generate a concise remediation report.

Frequently Asked Questions about docs-check

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

FAQPage Schema
How do I check ADR documentation quality and ensure decisions are reflected?โ–ผ

To check ADR documentation quality, validate that each ADR contains the decision, context, and rationale. A 5-axis documentation check identifies decay, bloat, and missing rationale across ADRs to ensure current decisions are accurately reflected.

What is the best way to detect outdated file paths and duplicated content in docs?โ–ผ

The best way to detect outdated file paths and duplication is performing a documentation hygiene scan. This checks for code-architecture mismatches, warns on obsolete paths, and identifies redundant content across flow, data-schema, and PRD documents.

How do I generate a remediation report for documentation decay and bloat?โ–ผ

Generate a remediation report by scanning docs/ for decay and bloat during a 5-axis check. The process produces a concise report containing practical cleanup suggestions tailored to reduce over-complicated sections and remove obsolete references.

Does documentation governance require ADRs to contain specific sections?โ–ผ

Documentation governance requires ADRs to contain the decision, context, and rationale sections. Validating these elements ensures architectural decisions are self-evident and properly tracked within your project's governance workflow.

Can I audit PRD and data-schema documents for redundancy and inference gaps?โ–ผ

You can audit PRD and data-schema documents by running a 5-axis check targeting inference and duplication. This analysis detects overlapping content and implicit reasoning gaps across your documentation set to improve overall clarity.

What are the limitations of automated documentation quality checks?โ–ผ

Automated documentation quality checks are limited to structural analysis of ADRs, flow, data-schema, and PRD files. They cannot assess subjective business logic correctness but instead flag inference gaps, duplicated paths, and excessive code blocks.