docs-check

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

Updated Jan 30, 2026
One-click install
npx skills add https://github.com/jon890/fos-blog --skill docs-check-jon890
Or copy as Structured Prompt for Agent
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.