docs

Audit, generate, and validate documentation against the codebase.

328|53|Updated Aug 1, 2025
One-click install
npx skills add https://github.com/automagik-dev/genie --skill docs-automagik-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/automagik-dev/genie/tree/main/skills/docs
Command: npx skills add https://github.com/automagik-dev/genie --skill docs-automagik-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of ensuring your codebase is well-documented by auditing existing documentation, identifying gaps, generating missing content, and validating its accuracy against the actual code.

Core Features & Use Cases

  • Documentation Audit: Scans for READMEs, guides, inline comments, and changelogs to map existing documentation.
  • Gap Identification: Compares documentation against the codebase to find missing, outdated, or incorrect information.
  • Automated Generation: Creates new documentation to fill identified gaps, adhering to project conventions.
  • Code Validation: Verifies that all documented elements (paths, APIs, behaviors) exist and are accurate in the code.
  • Use Case: After a major refactor, use this Skill to ensure all API endpoints and their parameters are correctly documented and that the descriptions match the implemented logic.

Quick Start

Use the docs skill to audit and update the documentation for the authentication module.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I audit technical documentation against my codebase?

To audit technical documentation against your codebase, the skill scans existing READMEs, guides, inline comments, and changelogs to map current documentation. It then cross-references this content with the actual code to identify missing, outdated, or incorrect information.

Can I automatically generate missing API docs for my project?

Yes, you can automatically generate missing API docs for your project. After identifying gaps in your existing documentation, the skill creates new content to fill those gaps, adhering to your project conventions and verifying that documented API paths and parameters match the implemented logic.

What is the best way to validate codebase documentation accuracy after a refactor?

The best way to validate codebase documentation accuracy after a refactor is to cross-reference documented elements with the actual code. The skill verifies that all documented paths, APIs, and behaviors exist and are accurate, ensuring descriptions match the newly implemented logic.

Does the documentation audit cover inline comments and changelogs?

Yes, the documentation audit covers inline comments and changelogs. The process scans for READMEs, technical guides, inline comments, and changelogs to comprehensively map existing documentation before comparing it against the codebase to find missing or outdated information.

How do I update outdated module descriptions in my technical documentation?

To update outdated module descriptions, the skill compares your existing documentation against the codebase to find discrepancies and automatically generates new content to fill identified gaps. It ensures all module descriptions adhere to your project conventions and match the code.