Can it update existing documentation or only create new files?

The skill includes workflows specifically designed to identify stale content and synchronize existing documentation with updated code logic and signatures.

How does it help with API documentation?

It automates the creation of JSDoc, Python docstrings, and OpenAPI (Swagger) specifications to ensure your APIs are developer-friendly and well-documented.

Does this skill support multiple programming languages?

Yes, it provides specific documentation patterns and templates for TypeScript, JavaScript, and Python, as well as general markdown structures.

Does it support architecture and system design docs?

Yes, it includes a workflow for creating ARCHITECTURE.md files to document system design, data flow, and key technical decisions.

Documentation Generation

Name: Documentation Generation
Author: hgeldenhuys

byhgeldenhuys

•

学習とドキュメンテーション

Automates the creation and maintenance of high-quality project documentation, including READMEs, API docs, and inline comments.

概要

The Documentation Generation skill empowers developers to maintain clear, consistent, and up-to-date documentation across their entire codebase. By providing structured templates and best practices for READMEs, JSDocs, and architecture diagrams, it ensures that technical documentation evolves alongside your code rather than becoming an afterthought. This skill is essential for maintaining project health, improving developer onboarding, and ensuring that API references and migration guides remain accurate through every release cycle.

主な機能

Syncs OpenAPI/Swagger specifications with REST API implementations
1 GitHub stars
Automates JSDoc and Python docstring creation for functions and classes
Generates standardized README.md files with quick-start and usage patterns
Provides templates for migration guides and architecture documentation
Identifies and updates stale code examples within existing documentation

ユースケース

Updating comprehensive API references after significant refactoring or feature additions
Initializing professional documentation for a new TypeScript or Python repository
Creating clear migration guides and changelogs for breaking changes in library releases

概要

主な機能

Syncs OpenAPI/Swagger specifications with REST API implementations
1 GitHub stars
Automates JSDoc and Python docstring creation for functions and classes
Generates standardized README.md files with quick-start and usage patterns
Provides templates for migration guides and architecture documentation
Identifies and updates stale code examples within existing documentation

ユースケース

Updating comprehensive API references after significant refactoring or feature additions
Initializing professional documentation for a new TypeScript or Python repository
Creating clear migration guides and changelogs for breaking changes in library releases