Vibe Index
🎯

documentation

🎯Skill

from congdon1207/agents.md

VibeIndex|
What it does

Enhances technical documentation by analyzing code, generating comments, creating API docs, and improving overall documentation quality.

πŸ“¦

Part of

congdon1207/agents.md(82 items)

documentation

Installation

git cloneClone repository
git clone https://github.com/your-repo/AGENTS.md
πŸ“– Extracted from docs: congdon1207/agents.md
Need more details? View full documentation on GitHub β†’
1Installs
-
AddedFeb 4, 2026
View on GitHubBack to Skills

Skill Details

SKILL.md

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".

Overview

> Skill Variant: Use this skill for interactive documentation tasks where the user is actively engaged. For autonomous documentation generation, use tasks-documentation instead.

# 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:

  1. "What assumptions am I making about [X]?"
  2. "Have I verified this with actual code evidence?"
  3. "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:

  1. Re-read the original task description
  2. Verify the current operation aligns with original goals
  3. Update the Current Focus in ## Progress section

---

PHASE 1: EXTERNAL MEMORY-DRIVEN DOCUMENTATION ANALYSIS

Build a structured knowledge model in .ai/workspace/analysis/[task-name].md.

PHASE 1A: INITIALIZATION AND DISCOVERY

  1. Initialize the analysis file with standard headings
  2. Discovery searches for all related files

DOCUMENTATION-SPECIFIC DISCOVERY

DOCUMENTATION_COMPLETENESS_DISCOVERY: Focus on documentation-relevant patterns:

  1. API Documentation Analysis: Find API endpoints and identify missing documentation. Document under ## API Documentation.
  1. Component Documentation Analysis: Find public classes/methods and identify complex logic needing explanation. Document under ## Component Documentation.
  1. 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 documentation
  • complexityLevel: How difficult to understand (1-10)
  • userFacingFeatures: Features needing user documentation
  • developerNotes: Technical details needing developer docs
  • exampleRequirements: Code examples or usage scenarios needed
  • apiDocumentationNeeds: API endpoints requiring documentation
  • configurationOptions: Configuration parameters needing explanation
  • troubleshootingAreas: 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

More from this repository10

🎯
frontend-development🎯Skill

Provides comprehensive React/TypeScript frontend development guidelines, covering component creation, feature structure, data fetching, routing, styling, and performance optimization.

🎯
react-patterns🎯Skill

Provides reusable design patterns, best practices, and architectural guidance for building robust and scalable React applications.

🎯
brainstorming🎯Skill

Skill

🎯
frontend-design🎯Skill

Generates distinctive, production-grade frontend interfaces by extracting design guidelines from references and implementing creative, high-quality web components and applications.

🎯
clean-code🎯Skill

Enforces software engineering best practices by automatically refactoring code to improve readability, maintainability, and adherence to clean coding principles.

🎯
database-design🎯Skill

Skill

🎯
senior-data-scientist🎯Skill

Skill

🎯
tasks-feature-implementation🎯Skill

Skill

🎯
parallel-agents🎯Skill

Skill

🎯
problem-solving🎯Skill

Skill