What is the Approval Gate?

The Approval Gate is a critical step in the process where the AI presents the documentation plan for explicit user approval before proceeding to ensure the strategy aligns with project goals.

How does it prevent incorrect information in the docs?

It uses strict anti-hallucination protocols, requiring evidence-chain validation and assumption checking against the actual source code before claiming any relationship or pattern.

Does this skill write the documentation for me?

This skill focuses on analysis and planning to ensure accuracy. For the actual writing task, it is recommended to use the tasks-documentation skill after this planning phase is complete.

What kind of documentation gaps can it find?

It identifies missing API documentation, undocumented public classes/methods, complex logic needing explanation, and missing configuration or troubleshooting guides.

Documentation Planner & Auditor

Name: Documentation Planner & Auditor
Author: CongDon1207

byCongDon1207

•

학습 및 문서화

Analyzes codebases to identify documentation gaps and creates structured documentation strategies based on actual code evidence.

소개

This skill transforms Claude into an expert technical writer and software documentation specialist. It uses a rigorous four-phase analysis process—discovery, planning, approval, and execution—to ensure technical documentation is accurate, complete, and derived directly from the source code. By implementing anti-hallucination protocols and systematic file analysis, it identifies missing API endpoints, complex logic requiring explanation, and user-facing features that need clarity, ultimately building a reliable knowledge model before any documentation is drafted.

주요 기능

Evidence-based gap identification for APIs and components
Anti-hallucination protocols for verified code relationships
Documentation strategy planning with mandatory approval gates
Structured knowledge modeling and documentation auditing
1 GitHub stars
Phased documentation analysis (4-step systematic workflow)

사용 사례

Planning a comprehensive documentation strategy for a new feature or API
Auditing an existing codebase for missing or outdated documentation
Identifying complex code patterns that require developer-focused technical notes

소개

주요 기능

Evidence-based gap identification for APIs and components
Anti-hallucination protocols for verified code relationships
Documentation strategy planning with mandatory approval gates
Structured knowledge modeling and documentation auditing
1 GitHub stars
Phased documentation analysis (4-step systematic workflow)

사용 사례

Planning a comprehensive documentation strategy for a new feature or API
Auditing an existing codebase for missing or outdated documentation
Identifying complex code patterns that require developer-focused technical notes