Documentation Generation
Plugin Verified ActiveOpenAPI specification generation, Mermaid diagram creation, tutorial writing, API reference documentation
To streamline and enhance the creation of technical documentation, making it easier for developers to generate accurate and maintainable API specs, architecture diagrams, and user guides.
Features
- Automated API documentation generation (OpenAPI 3.1)
- Mermaid diagram creation for system architectures and flows
- Step-by-step tutorial and user guide writing
- Comprehensive technical reference building
- Code analysis for documentation extraction
Use Cases
- Generating OpenAPI specs from existing code or designs
- Creating architecture diagrams for system understanding
- Writing onboarding tutorials for new users or developers
- Building comprehensive API reference documentation
Non-Goals
- Generating code from documentation
- Performing code reviews or quality analysis
- Managing project infrastructure or deployments
Workflow
- Analyze codebase or design specifications
- Generate OpenAPI specifications
- Create architecture diagrams (e.g., Mermaid)
- Write user tutorials and guides
- Produce technical references and API documentation
Practices
- Documentation Generation
- API Design
- Technical Writing
- Diagramming
Code Execution
- info:ValidationWhile the code analysis logic (AST parsing) and templating are present, explicit schema validation libraries like Zod or Pydantic for input arguments are not clearly demonstrated in the provided snippets.
Errors
- info:Actionable error messagesWhile code examples show basic error handling, the provided snippets do not explicitly demonstrate user-facing error messages with remediation steps or doc links.
Installation
First, add the marketplace
/plugin marketplace add wshobson/agents/plugin install documentation-generation@claude-code-workflowsContains 3 extensions
Skill (3)
Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation. Use when documenting significant technical decisions, reviewing past architectural choices, or establishing decision processes.
Automate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.
Quality Score
VerifiedTrust Signals
Similar Extensions
Context7 Plugin
100Upstash Context7 MCP server for up-to-date documentation lookup. Pull version-specific documentation and code examples directly from source repositories into your LLM context.
Ruflo Docs
99Documentation generation, API docs (JSDoc/TSDoc/OpenAPI), and drift detection — drives the `document` background worker via hooks_worker-dispatch; uses Haiku model for cost-efficient docs work
Coding Tutor
98Personalized coding tutorials that use your actual codebase for examples with spaced repetition quizzes
Deep Wiki
97AI-powered wiki generator for code repositories. Generates comprehensive, Mermaid-rich documentation with dark-mode VitePress sites, onboarding guides, deep research, and source citations. Inspired by OpenDeepWiki and deepwiki-open.
Hello World
96A simple example plugin that demonstrates basic Claude Code plugin functionality