docs

Generate and audit API, code, README, and runbook documentation.

26|8|Updated Mar 19, 2026
One-click install
npx skills add https://github.com/arbazkhan971/godmode --skill docs-arbazkhan971
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/arbazkhan971/godmode/tree/main/skills/docs
Command: npx skills add https://github.com/arbazkhan971/godmode --skill docs-arbazkhan971

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation gaps and stale information slow teams and degrade onboarding. This Skill automates the generation, auditing, and upkeep of project docs to ensure accuracy across APIs, code, READMEs, and runbooks.

Core Features & Use Cases

  • API docs: Generate OpenAPI/Swagger specs and maintain endpoint documentation across evolving APIs.
  • Code docs: Generate JSDoc/docstrings and perform inline documentation quality checks.
  • README generation: Create and update project/module READMEs to improve discoverability.
  • Runbooks: Create operational runbooks for deployments, incidents, and maintenance.
  • Quality audits: Detect stale docs, coverage gaps, and obsolescence to drive fixes.

Quick Start

Run a full documentation sweep for the current project using /godmode:docs to generate, audit, and update all docs.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I automate API documentation generation for evolving codebases?

Automate API documentation by analyzing code to generate and maintain OpenAPI/Swagger specs and endpoint documentation, ensuring docs stay synchronized with evolving APIs across codebases and CI pipelines.

What is the best way to detect stale documentation and coverage gaps?

Detect stale documentation and coverage gaps by running quality audits that produce reports with staleness metrics and coverage analysis, identifying obsolete docs and missing information across your project.

Can I generate JSDoc and README files directly from my source code?

Yes, you can generate JSDoc, docstrings, and project READMEs directly from source code by discovering frontmatter sources and analyzing code structure to produce inline documentation and improve discoverability.

How do I create operational runbooks for deployments and incident response?

Create operational runbooks for deployments, incidents, and maintenance by automating runbook generation, ensuring operational documentation remains accurate and accessible during handover situations and CI pipeline executions.

Does this documentation automation work within existing CI pipelines?

Yes, documentation automation applies across codebases and CI pipelines, enabling continuous generation, auditing, and upkeep of project docs to prevent stale or missing information during development workflows.

What problems does automated documentation maintenance solve for onboarding teams?

Automated documentation maintenance solves onboarding delays caused by documentation gaps and stale information, ensuring accuracy across APIs, code, READMEs, and runbooks to prevent knowledge degradation.