doc-reviewer

Identify and fix truth-grounding, accuracy, clarity, and completeness gaps in documentation.

1|Updated Jun 7, 2024
One-click install
npx skills add https://github.com/jsco2t/dotfiles --skill doc-reviewer-jsco2t
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-reviewer
Source: https://github.com/jsco2t/dotfiles/tree/main/.claude/skills/doc-reviewer
Command: npx skills add https://github.com/jsco2t/dotfiles --skill doc-reviewer-jsco2t

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

You are an expert documentation reviewer. Your primary responsibility is to ensure documents are accurate, clear, easy to consume, and 100% grounded in the truth of whatever they describe. You also identify structural problems — documents that try to cover too much, missing companion documents, and gaps in a documentation set.

Core Features & Use Cases

  • Truth-grounding verification across multiple documents
  • Cross-document coherence checks and gap detection
  • Structural splitting recommendations for large documentation sets
  • Consistency and terminology alignment across the document set
  • Gap analysis with actionable remediation suggestions

Quick Start

Review the target document or directory and report grounded, prioritized issues with actionable recommendations.

Frequently Asked Questions about doc-reviewer

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

FAQPage Schema
How do I review documentation for accuracy and consistency across multiple files?

Documentation review for consistency involves evaluating coherence, coverage, and terminology alignment across multiple files, flagging gaps or misalignments. Cross-document checks verify truth-grounding and ensure companion documents exist where needed.

What is documentation truth-grounding and how does it work?

Truth-grounding verification ensures documents are 100% grounded in the truth of whatever they describe. It checks accuracy across multiple documents, identifying gaps and misalignments to provide actionable remediation guidance.

How do I identify gaps and missing companion documents in a document set?

Gap analysis identifies missing companion documents and coverage gaps across a document set by performing cross-document checks. It evaluates structural completeness, flagging where companion documents are needed and providing actionable remediation suggestions.

Can I review a whole directory of documents or only individual files?

Yes, documentation review applies to individual files or whole document sets. It evaluates each document's coherence, coverage, and consistency, performing cross-document checks to identify gaps and structural problems across the entire directory.

What is the best way to fix structural problems in large documentation sets?

To fix structural problems in large documentation sets, identify documents covering too much scope and apply structural splitting recommendations. This gap analysis flags misalignments, ensures companion documents exist, and delivers actionable remediation guidance.

Why does my documentation have terminology misalignments across different files?

Terminology misalignments occur when documents lack cross-document consistency checks. Evaluating coherence, coverage, and terminology alignment across the document set identifies these gaps and provides actionable remediation suggestions to align them.