documentation

Generate API docs, architecture diagrams, and READMEs from codebases.

1|Updated Aug 17, 2025
One-click install
npx skills add https://github.com/DuySeu/StockMind --skill documentation-duyseu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/DuySeu/StockMind/tree/main/.agent/skills/documentation
Command: npx skills add https://github.com/DuySeu/StockMind --skill documentation-duyseu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates end-to-end documentation generation across codebases, reducing manual effort and ensuring consistent quality.

Core Features & Use Cases

  • API documentation generation and OpenAPI spec creation for APIs.
  • Architecture diagrams, README generation, and code comments extraction to produce developer guides and wikis.
  • Automated maintenance and updates across projects, templates and workflows to keep docs in sync with code.
  • Use Case: When onboarding a new team or releasing a feature, run the workflow to produce API refs, architecture docs, and user guides from the repository.

Quick Start

Trigger the workflow against your codebase to generate API docs, architecture diagrams, and README content automatically.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I automate project documentation generation across a codebase?

You can automate project documentation generation by triggering a phase-driven workflow against your codebase to produce API docs, architecture notes, and READMEs automatically. This process extracts code comments and uses templates to ensure consistent quality.

Can I generate API docs and OpenAPI specs from my existing code?

Yes, you can generate API documentation and create OpenAPI specs directly from your existing codebase. The workflow analyzes your API endpoints and produces structured API references and developer guides.

What is the best way to keep architecture notes and wikis in sync with code?

The best way to keep architecture notes and wikis in sync is using automated maintenance hooks. These hooks update documentation alongside code changes to prevent manual updates and ensure docs stay aligned.

Does this documentation workflow support markdown templates for wikis and READMEs?

Yes, the documentation workflow supports markdown templates. It uses these templates to generate wikis, READMEs, and architecture diagrams, ensuring consistent formatting and structure across different software projects.

How do I create developer guides and architecture diagrams for team onboarding?

To create developer guides and architecture diagrams for onboarding, run the workflow against your repository. It extracts code comments and generates architecture notes and user guides to help new team members understand the project.