code-documentation-generator

Generate JSDoc, Google and NumPy docstrings, and REST API documentation.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/dengineproblem/agents-monorepo --skill code-documentation-generator-dengineproblem
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documentation-generator
Source: https://github.com/dengineproblem/agents-monorepo/tree/main/.claude/skills/code-documentation-generator
Command: npx skills add https://github.com/dengineproblem/agents-monorepo --skill code-documentation-generator-dengineproblem

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive and clear documentation for code, improving maintainability and developer understanding.

Core Features & Use Cases

  • JSDoc/Docstrings: Generates documentation comments for JavaScript, TypeScript, and Python.
  • API Documentation: Creates documentation for REST APIs in both OpenAPI/Swagger and Markdown formats.
  • README Templates: Provides structured templates for project README files.
  • Inline Comments: Offers guidance on writing effective inline comments.
  • Automation Tools: Shows examples of configuring tools like TypeDoc and Sphinx for automated documentation generation.
  • Use Case: You have a complex Python function and need to generate a clear docstring following Google's style guide, including arguments, return types, and potential exceptions.

Quick Start

Use the code-documentation-generator skill to generate a JSDoc comment for the provided JavaScript function.

Frequently Asked Questions about code-documentation-generator

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

FAQPage Schema
How do I generate JSDoc comments for JavaScript and TypeScript functions?

To generate JSDoc comments for JavaScript and TypeScript, provide your function code to the documentation generator to automatically create structured annotations including parameters, return types, and descriptions.

What is the best way to write Python docstrings following the Google or NumPy style guide?

Writing Python docstrings following Google or NumPy style guides is best handled by submitting your function to a documentation generator, which outputs formatted arguments, return types, and exceptions.

Can I create OpenAPI or Swagger documentation for a REST API in YAML?

Yes, you can create OpenAPI or Swagger documentation for a REST API in YAML format by providing your API endpoints to the documentation generator, which outputs structured YAML and Markdown files.

How do I configure Sphinx or TypeDoc for automated code documentation generation?

Configuring Sphinx or TypeDoc for automated code documentation generation involves defining build configurations and input paths, which this tool demonstrates through practical setup examples.

Does this documentation generator provide structured templates for project README files?

Yes, the documentation generator provides structured templates for project README files, helping you standardize project overviews, installation steps, and usage instructions for developers.

When do I need to write inline code comments instead of standard docstrings?

You need to write inline code comments instead of standard docstrings when explaining complex logic blocks within a function, and this generator offers guidance on making those comments effective.