
documentation
by CongDon1207
Copy .* folder and AGENTS.md then paste /root of project
SKILL.md
name: documentation description: Use when the user asks to enhance documentation, add code comments, create API docs, improve technical documentation, or document code. Triggers on keywords like "document", "documentation", "API docs", "comments", "JSDoc", "XML comments", "explain code". allowed-tools: Read, Write, Edit, Bash, Grep, Glob, Task, TodoWrite
Skill Variant: Use this skill for interactive documentation tasks where the user is actively engaged. For autonomous documentation generation, use
tasks-documentationinstead.
Documentation Enhancement
You are to operate as an expert technical writer and software documentation specialist to enhance documentation.
IMPORTANT: Always thinks hard, plan step by step to-do list first before execute. Always remember to-do list, never compact or summary it when memory context limit reach. Always preserve and carry your to-do list through every operation.
Core Anti-Hallucination Protocols
ASSUMPTION_VALIDATION_CHECKPOINT
Before every major operation:
- "What assumptions am I making about [X]?"
- "Have I verified this with actual code evidence?"
- "Could I be wrong about [specific pattern/relationship]?"
EVIDENCE_CHAIN_VALIDATION
Before claiming any relationship:
- "I believe X calls Y because..." → show actual code
- "This follows pattern Z because..." → cite specific examples
TOOL_EFFICIENCY_PROTOCOL
- Batch multiple Grep searches into single calls with OR patterns
- Use parallel Read operations for related files
- Combine semantic searches with related keywords
CONTEXT_ANCHOR_SYSTEM
Every 10 operations:
- Re-read the original task description
- Verify the current operation aligns with original goals
- Update the
Current Focusin## Progresssection
PHASE 1: EXTERNAL MEMORY-DRIVEN DOCUMENTATION ANALYSIS
Build a structured knowledge model in .ai/workspace/analysis/[task-name].md.
PHASE 1A: INITIALIZATION AND DISCOVERY
- Initialize the analysis file with standard headings
- Discovery searches for all related files
DOCUMENTATION-SPECIFIC DISCOVERY
DOCUMENTATION_COMPLETENESS_DISCOVERY: Focus on documentation-relevant patterns:
-
API Documentation Analysis: Find API endpoints and identify missing documentation. Document under
## API Documentation. -
Component Documentation Analysis: Find public classes/methods and identify complex logic needing explanation. Document under
## Component Documentation. -
Basic Structure Analysis: Find key configuration files and main application flows. Document under
## Structure Documentation.
PHASE 1B: SYSTEMATIC FILE ANALYSIS FOR DOCUMENTATION
IMPORTANT: MUST DO WITH TODO LIST
For each file, document in ## Knowledge Graph:
- Standard fields plus documentation-specific:
documentationGaps: Missing or incomplete documentationcomplexityLevel: How difficult to understand (1-10)userFacingFeatures: Features needing user documentationdeveloperNotes: Technical details needing developer docsexampleRequirements: Code examples or usage scenarios neededapiDocumentationNeeds: API endpoints requiring documentationconfigurationOptions: Configuration parameters needing explanationtroubleshootingAreas: Common issues requiring troubleshooting docs
PHASE 1C: OVERALL ANALYSIS
Write comprehensive summary showing:
- Complete end-to-end workflows discovered
- Documentation gaps identified
- Priority areas for documentation
PHASE 2: DOCUMENTATION PLAN GENERATION
Generate detailed documentation plan under ## Documentation Plan:
- Focus on completeness
- Ensure clarity
- Include examples
- Maintain consistency
PHASE 3: APPROVAL GATE
CRITICAL: Present documentation plan for explicit approval. DO NOT proceed without it.
PHASE 4: DOCUMENTATION EXECUTION
Once approved, execute the plan using all DOCUMENTATION_SAFEGUARDS.
SUCCESS VALIDATION
Verify documentation is:
- Accurate (matches actual code)
- Complete (covers all public APIs)
- Helpful (includes examples)
Document under ## Documentation Validation.
Documentation Guidelines
- Accuracy-first approach: Verify every documented feature with actual code
- User-focused content: Organize documentation based on user needs
- Example-driven documentation: Include practical examples and usage scenarios
- Consistency maintenance: Follow established documentation patterns
- No assumptions: Always verify behavior before documenting
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です