skills.rest
j0KZ
j0KZCOMMUNITY
Explore all skills by this author →
GitHub

documentation-generation

Generate READMEs, changelogs, and API docs from TypeScript sources.

Updated Oct 1, 2025
Search Tags:#documentation#readme#docs#wiki#CHANGELOG#API-docs
One-click install
npx skills add https://github.com/j0KZ/mcp-agents --skill documentation-generation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generation
Source: https://github.com/j0KZ/mcp-agents/tree/main/starter-kit/template/.claude/skills/documentation-generation
Command: npx skills add https://github.com/j0KZ/mcp-agents --skill documentation-generation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates documentation generation and maintenance across the monorepo.

Core Features & Use Cases

  • README generation for packages to ensure consistent structure
  • CHANGELOG management aligned with releases
  • API documentation generation from TypeScript sources
  • Wiki synchronization workflows and badge updates

Quick Start

npx @j0kz/doc-generator@latest generate readme --package=smart-reviewer-mcp npx @j0kz/doc-generator@latest generate api --input=src --output=docs/api npx @j0kz/doc-generator@latest generate changelog --version=1.0.0

Frequently Asked Questions about documentation-generation

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

FAQPage Schema
How do I automate README and CHANGELOG generation for my monorepo packages?▼

README and CHANGELOG generation automates creating consistent documentation across multiple packages. This Skill generates READMEs with standard structure and manages CHANGELOGs aligned to releases using conventional changelog formatting, keeping all package docs in sync without manual updates.

Can I generate API documentation directly from TypeScript source files?▼

Yes, API documentation generation extracts TypeScript source code and produces formatted API docs automatically. This Skill parses TypeScript to generate comprehensive API reference documentation, eliminating manual doc writing and keeping it synchronized with code changes.

What's the best way to keep documentation and badges updated when releasing packages?▼

Documentation and badge automation synchronizes READMEs, CHANGELOGs, wiki pages, and status badges across releases in a single workflow. This Skill handles badge updates, wiki sync, and changelog formatting together, ensuring all documentation reflects the current release state.

Does this work with CI/CD pipelines for automated documentation workflows?▼

Yes, this Skill supports CI/CD integration for automated documentation workflows. It enables template-driven generation and conventional changelog formatting that fits into continuous deployment pipelines, automating docs updates on every release or commit.

Can I use this for monorepos with multiple packages that need consistent documentation structure?▼

Monorepo documentation generation is a core use case for this Skill. It applies templates and automation across multiple packages simultaneously, ensuring consistent README structure, aligned CHANGELOGs, and synchronized API docs across your entire monorepo.

Related Skills

Explore More Software Engineering Skills→
Snowflake-LabsSnowflake-Labs
12

read-ors-configuration

A concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略

Official
Intermediate
ChegginCheggin
1

documentation-generator

Generate API references, user guides, and changelogs from code and git history.

Community
Advanced
martin-jancimartin-janci

prepare-release

Identify the latest release tag and generate a changelog preview from commits.

Community
Intermediate
blackplume233blackplume233
12

wiki-updater

Synchronize Actant wiki content from stage and ship changes.

Community
Advanced