Documentation Generator Skill

This skill provides documentation generation capabilities for the Chief of Staff plugin.

Capabilities

README Generation

• •Create comprehensive README files
• •Include installation instructions
• •Add usage examples
• •Document configuration options

API Documentation

• •Generate API reference documentation
• •Document endpoints and parameters
• •Include request/response examples
• •Create OpenAPI/Swagger specs

Code Comments

• •Add JSDoc/TSDoc comments
• •Document function parameters and returns
• •Include usage examples in comments
• •Generate inline documentation

Changelog Management

• •Create changelog entries
• •Follow Keep a Changelog format
• •Link to commits and issues
• •Categorize changes properly

User Guides

• •Write getting started guides
• •Create tutorials
• •Document workflows
• •Build FAQ sections

Usage

When generating documentation, I will:

1. •

   Analyze the Code: Understand the structure, APIs, and purpose of the code.

2. •

   Extract Information: Identify functions, classes, parameters, and their purposes.

3. •

   Generate Content: Create clear, helpful documentation following best practices.

4. •

   Maintain Consistency: Use consistent style and formatting throughout.

Triggers

This skill activates when:

• •You request documentation
• •You use /docs, /readme, or /changelog commands
• •New files are created or modified (optional)

Configuration

• •style: Documentation format (markdown, jsdoc, sphinx, rustdoc)
• •includeExamples: Add code examples automatically
• •verbosity: Level of detail (minimal, standard, comprehensive)

Examples

Generate README

"Create a README for this project"

API Documentation

"Document the API endpoints in this service"

Changelog Entry

"Add a changelog entry for the new feature"

Code Comments

"Add documentation comments to this module"