Can it update my existing README without overwriting everything?

Yes, it intelligently analyzes your existing README.md to update project descriptions, installation steps, and feature lists while preserving current badges and custom sections.

Do I need to follow a specific docstring format?

While it works best with standard formats like JSDoc, Google, or NumPy style, the underlying AI can intelligently extract meaning from most structured code comments.

Which programming languages does this skill support?

The skill identifies and extracts documentation from Python, TypeScript, JavaScript, Go, and Rust projects by analyzing file extensions and package managers.

How does the changelog generation work?

It parses your git history for conventional commits and automatically categorizes updates into features, bug fixes, and breaking changes grouped by version.

Automated Documentation Generator

Name: Automated Documentation Generator
Author: laurigates

bylaurigates

•

학습 및 문서화

Generates and updates comprehensive project documentation, API references, and changelogs directly from your codebase and git history.

The docs-generate skill automates the maintenance of technical documentation by extracting context directly from source code, docstrings, and type annotations. By analyzing your project's structure and commit history, it can automatically build detailed API references, professional README files, and structured changelogs. This ensures your documentation remains synchronized with your implementation, reducing manual overhead and improving developer experience across Python, TypeScript, Go, and other major languages.

주요 기능

01Automatic API reference generation from docstrings and type annotations

02Extraction of usage examples from existing test suites and source files

03Intelligent README updates including installation guides and feature lists

0410 GitHub stars

05Automated CHANGELOG generation based on conventional git commits

06Multi-language support for Python, JavaScript, TypeScript, Go, and Rust

사용 사례

01Maintaining up-to-date public API documentation during rapid development

02Automating release notes and version history before a deployment

03Generating a professional README for a new open-source repository

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add laurigates/claude-plugins docs-generate

For use in Claude.ai and ChatGPT

Download Skill