skills.rest
jeffwweee
jeffwweeeCOMMUNITY
Explore all skills by this author →
GitHub

docs-creator

Generates README, REST API, Javadoc, and TSDoc documentation from code.

Updated Feb 20, 2026
Search Tags:#documentation#readme#code comments#api docs#tsdoc#javadoc
One-click install
npx skills add https://github.com/jeffwweee/dev-workspace --skill docs-creator-jeffwweee
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-creator
Source: https://github.com/jeffwweee/dev-workspace/tree/main/.claude/skills/docs-creator
Command: npx skills add https://github.com/jeffwweee/dev-workspace --skill docs-creator-jeffwweee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and generation of essential software documentation, reducing the burden on developers and ensuring consistency.

Core Features & Use Cases

  • README Generation: Create or update project README files with clear setup, usage, and API information.
  • API Documentation: Document REST APIs with endpoints, parameters, request/response examples, and error codes.
  • Code Commenting: Generate Javadoc for Java and TSDoc for TypeScript, explaining functions, classes, and types.
  • Use Case: You've just finished building a new API endpoint. Use this Skill to generate its documentation, including a curl example, and add TSDoc comments to the relevant TypeScript functions.

Quick Start

Use the docs-creator skill to generate a README file for the current project.

Frequently Asked Questions about docs-creator

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

FAQPage Schema
How do I generate TSDoc comments for my TypeScript functions?▼

Generate TSDoc comments for TypeScript functions by analyzing code signatures to automatically document functions, classes, and types. This skill creates standardized TSDoc annotations based on the existing code structure and reference patterns.

What is the best way to create a README file for my software project?▼

Creating a README file is done by generating project overviews with clear setup, usage, and API information sections. This skill automates README generation using templates and reference files to ensure consistent documentation structure.

How do I document REST API endpoints with request and response examples?▼

Document REST API endpoints by generating specifications that include parameters, request and response examples, and error codes. This skill automates API documentation creation based on code signatures to provide accurate endpoint references.

Can I generate Javadoc for my Java code automatically?▼

Generate Javadoc for Java code automatically by parsing class and function signatures to create explanatory comments. This skill supports automated Javadoc generation to ensure consistent code commenting across Java projects.

Does this documentation generator work with both TypeScript and Java projects?▼

This documentation generator works with both TypeScript and Java projects, supporting TSDoc and Javadoc generation respectively. It also handles README files and REST API specifications across these software engineering environments.

How do I update existing API documentation when endpoints change?▼

Update existing API documentation by regenerating specifications based on updated code signatures, modifying endpoints, parameters, and examples. This skill supports updating current software documentation to reflect codebase changes accurately.

Related Skills

Explore More Software Engineering Skills→
samjhechtsamjhecht
4

design-system-governance

Detect design token drift between Figma and code implementations.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
hashicorphashicorp
78

code-review

Validate Terraform, Packer, Vault, Nomad, and Consul code blocks in Markdown/MDX documentation.

Official
Advanced
penghang1223penghang1223
1

doc-generator

Extract code comments and annotations into Markdown, JSON, or OpenAPI YAML documentation.

Community
Intermediate