Which programming languages does this skill support?

While the core templates are optimized for TypeScript and JavaScript (JSDoc/TSDoc), the skill's logic for README and API generation can be adapted to any language using standard documentation patterns.

Does this skill help with project versioning?

Yes, it includes specialized workflows for maintaining a structured CHANGELOG.md, helping you track additions, fixes, and breaking changes for every version.

Can it update existing documentation or only create new files?

The skill can analyze existing code and documentation to fill in missing descriptions, parameters, and return types, ensuring your docs stay up-to-date with your latest changes.

How does it ensure documentation accuracy?

It follows a multi-step workflow that includes reading the implementation first, then uses validation tools like TypeDoc and documentation linting to verify the output.

Doc Generator

Name: Doc Generator
Author: ShunsukeHayashi

byShunsukeHayashi

•

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

Generates professional documentation including JSDoc, README files, and API references by analyzing code implementation.

The Doc Generator skill automates the creation and maintenance of technical documentation for software projects. It analyzes your source code to extract implementation details and generates high-quality JSDoc/TSDoc comments, comprehensive README files, and structured API documentation. This skill is ideal for developers who want to improve project maintainability, ensure documentation consistency, and automate the tedious process of keeping changelogs and manuals synchronized with code changes.

主な機能

01Automated JSDoc and TSDoc generation for functions, classes, and interfaces

02Standardized CHANGELOG management to track project versions and updates

03Comprehensive README.md creation with features, installation, and usage guides

04Integrated documentation validation using TypeDoc and ESLint standards

05Systematic API reference generation directly from source code analysis

067 GitHub stars

ユースケース

01Generating production-ready README files for new open-source projects or libraries

02Documenting legacy codebases to improve team onboarding and long-term maintenance

03Standardizing documentation styles across large monorepos and team-based repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add shunsukehayashi/miyabi doc-generator

For use in Claude.ai and ChatGPT

Download Skill