/docs

Description

Generate comprehensive documentation for the specified code. Include:

AI Summary

Generates comprehensive documentation for code including API specs, usage examples, configuration, and dependencies in professional markdown format. Use this to create READMEs or API references for functions, modules, or entire projects.

Install

Add the repository(one-time)

/plugin marketplace add androidyue/claude_code_plugin_example

Install the plugin

/plugin install dev-essentials@dev-essentials-marketplace

Command Content

Generate comprehensive documentation for the specified code. Include:

Overview
- Purpose and functionality
- Key features
- Use cases
API Documentation
- Function/method signatures
- Parameter descriptions with types
- Return values
- Exceptions/errors that may be thrown
Usage Examples
- Basic usage examples
- Advanced use cases
- Common patterns
Configuration
- Required environment variables
- Configuration options
- Default values
Dependencies
- Required libraries
- Version requirements
- Installation instructions
Additional Notes
- Known limitations
- Performance considerations
- Best practices

Format the documentation in clear, professional markdown suitable for a README or API reference.

Links

GitHub Stats

0 forks

Updated 2 months ago

Other plugins with /docs

/docs

Update or generate YAML documentation for SQL models with proper descriptions and tests

ReadWriteEdit

all-commands

2.2k

/docs

Update or generate YAML documentation for SQL models with proper descriptions and tests

ReadWriteEdit

commands-documentation-changelogs

2.2k

/docs

`/project:docs <CODE_SCOPE_DESCRIPTION>`

development-essentials

1.7k

/docs

Generate comprehensive YAML documentation from Go struct definitions with sensible default values

yaml

/docs

Unified documentation management - generate, validate, sync, update, and analyze documentation

claude-sonnet-4-5ReadWriteEdit+6

ai-toolkit