skills.rest
hirokazu-kobayashi-koba-hiro
hirokazu-kobayashi-koba-hiroCOMMUNITY
Explore all skills by this author →
GitHub

review-documentation

Verify documentation accuracy against authoritative sources and generate a structured factual report.

7|1|Updated Feb 12, 2023
Search Tags:#documentation#consistency#fact-checking#evidence#review#technical-accuracy
One-click install
npx skills add https://github.com/hirokazu-kobayashi-koba-hiro/idp-server --skill review-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-documentation
Source: https://github.com/hirokazu-kobayashi-koba-hiro/idp-server/tree/main/.claude/skills/review-documentation
Command: npx skills add https://github.com/hirokazu-kobayashi-koba-hiro/idp-server --skill review-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams ensure documentation is technically accurate, consistent, and supported by credible sources, reducing the risk of miscommunication and incorrect implementations.

Core Features & Use Cases

  • Checklist-based verification: Uses a structured guide to validate terminology, references, and claims.
  • Evidence collection: Captures sources and reasoning to support remediation and updating docs.
  • Use Case: Review API docs to confirm parameter semantics align with official specifications and common usage patterns.

Quick Start

Read a documentation file and run the guided review to produce a structured factual report describing gaps and suggested corrections.

Frequently Asked Questions about review-documentation

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

FAQPage Schema
How do I verify technical documentation for factual accuracy against authoritative sources?▼

Documentation review applies a checklist-driven verification process to identify factual inaccuracies, flag inconsistencies, and capture evidence for remediation against authoritative sources.

What is the best way to check API documentation consistency with official specifications?▼

API documentation consistency is validated by applying a structured review workflow that targets technical documents, confirms parameter semantics align with official specifications, and outputs a report-ready factual summary.

How does evidence collection work during a technical documentation review?▼

Evidence collection captures authoritative sources and reasoning during the documentation review to support remediation, providing a formal, report-ready output that details gaps and suggested corrections.

Can I use a structured checklist to review terminology and references in technical docs?▼

A structured checklist validates terminology, references, and claims in technical docs by guiding the verification process, optionally performing web searches, and flagging inconsistencies for correction.

When do I need a formal documentation review workflow for technical accuracy?▼

A formal documentation review workflow is needed when teams must ensure technical accuracy, consistency, and credible source support to reduce the risk of miscommunication and incorrect implementations.

Does documentation fact-checking support web searches for verifying external references?▼

Documentation fact-checking supports optional web searches to verify external references, capturing sources and reasoning to produce a structured factual report describing documentation gaps and suggested corrections.

Related Skills

Explore More Education & Research Skills→
nullskymcnullskymc
10

web-search

Search public web sources and consolidate findings into summaries.

Community
Intermediate
maxenergymaxenergy

grill-with-docs

Align domain terminology and decisions by updating CONTEXT.md and ADRs inline.

Community
Advanced
jgezelscorpjgezelscorp

count-registry

Maintain entity counts in a project via a manifest file and automated validation.

Community
Basic
timequitytimequity
6

verification-gate

Automates verification of tests, builds, linting, and security checks before completion.

Official
Intermediate