doc-gen

Generate style-matched documentation for code modules, directories, and APIs.

820|78|Updated Mar 20, 2026

Search Tags:#documentation #readme #jsdoc #docs #code #documentation-generator

Ready to run

npx skills add https://github.com/SethGammon/Citadel --skill doc-gen-sethgammon

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-gen
Source: https://github.com/SethGammon/Citadel/tree/main/skills/doc-gen
Command: npx skills add https://github.com/SethGammon/Citadel --skill doc-gen-sethgammon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often manual, inconsistent, and time-consuming. This Skill analyzes code and project conventions to generate cohesive, style-aligned documentation automatically, reducing drift and repetitive work.

Core Features & Use Cases

Mode-aware generation for functions, modules, and APIs.
Non-invasive README and reference generation that respects existing docs.
Style matching to project conventions (CLAUDE.md, existing docs).

Quick Start

Run /doc-gen [target] on a file or directory to generate documentation in the project's style.

Frequently Asked Questions about doc-gen

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

FAQPage Schema

How do I generate documentation from an existing codebase automatically?▼

To generate documentation automatically, this Skill analyzes your existing codebase, project conventions, and code annotations to produce cohesive, style-aligned function-level docs, module READMEs, or API references.

Can I generate a README without overwriting my existing docs?▼

Yes, you can generate a README without overwriting existing docs because this Skill performs non-invasive generation that explicitly respects current documentation and matches the target's voice and formatting conventions.

How do I match new API reference documentation to my project's style?▼

To match new API reference documentation to your project's style, this Skill analyzes existing documentation styles, project conventions, and code annotations to ensure the output matches your target's voice and formatting.

What is the best way to create JSDoc-style documentation for multiple modules?▼

The best way to create JSDoc-style documentation for multiple modules is using a mode-aware generator that analyzes code and project conventions to produce cohesive, style-aligned references for specific directories or API surfaces.

Do I need to configure anything before generating docs for a directory?▼

You do not need complex configuration before generating docs for a directory; simply run the command on your target file or directory and it analyzes existing conventions to produce documentation in the project's style.