skills.rest
korallis
korallisCOMMUNITY
Explore all skills by this author →
GitHub

documentation-generation

Automates generation of technical documentation for software projects.

90|10|Updated Nov 8, 2025
Search Tags:#documentation#readme#api docs#storybook#code documentation#docusaurus#developer guides
One-click install
npx skills add https://github.com/korallis/Droidz --skill documentation-generation-korallis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generation
Source: https://github.com/korallis/Droidz/tree/main/droidz_installer/payloads/droid_cli/default/skills/documentation-generation
Command: npx skills add https://github.com/korallis/Droidz --skill documentation-generation-korallis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill automates the creation and maintenance of comprehensive technical documentation, ensuring your projects are well-understood and easily navigable.

Core Features & Use Cases

  • API Documentation: Generate docs for REST (OpenAPI/Swagger) and GraphQL APIs.
  • Code Documentation: Create inline JSDoc/TSDoc comments and generate reference docs (TypeDoc).
  • Project Documentation: Structure READMEs, Changelogs, and developer guides.
  • Documentation Sites: Build sites with VitePress or Docusaurus.
  • Automated Checks: Implement link checking and code example testing in CI.
  • Use Case: Automatically generate API documentation from your TypeScript code and deploy it as a user-friendly website.

Quick Start

Use the documentation-generation skill to create a README.md file for your project.

Frequently Asked Questions about documentation-generation

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

FAQPage Schema
How do I generate API documentation from TypeScript code?▼

To generate API documentation from TypeScript code, this skill automates the creation of inline JSDoc and TSDoc comments, and generates reference docs using TypeDoc for REST and GraphQL APIs.

What is the best way to automate README and CHANGELOG generation for software projects?▼

Automating README and CHANGELOG generation is handled by structuring project documentation, including developer guides, to ensure your software projects remain well-understood and easily navigable.

Can I use Docusaurus or VitePress to build a documentation site from OpenAPI specifications?▼

Yes, you can build static documentation sites with Docusaurus or VitePress, using the skill to generate and integrate your OpenAPI and Swagger specifications into a user-friendly website.

How do I test code examples and check links in documentation within a CI pipeline?▼

Testing code examples and checking links in documentation is achieved by implementing automated checks directly within your CI pipelines, ensuring all references and examples remain valid.

Does automated documentation generation work with both REST and GraphQL APIs?▼

Automated documentation generation works with both REST and GraphQL APIs, creating comprehensive technical documentation to ensure your API endpoints are well-understood and easily navigable.

Related Skills

Explore More Software Engineering Skills→
luyi985luyi985

codegen-over-complex-types

Generate TypeScript types from OpenAPI, GraphQL, or database schemas.

Community
Advanced
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
mvallimmvallim
7

generate-markdown-docs

Generate Markdown documentation from codebases with customizable headings and dependencies.

Community
Intermediate