doc-generator

Generate and update Go documentation from source code.

Updated Oct 23, 2025
One-click install
npx skills add https://github.com/kis9a/claude-skills-demo --skill doc-generator-kis9a
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/kis9a/claude-skills-demo/tree/main/.claude/skills/doc-generator
Command: npx skills add https://github.com/kis9a/claude-skills-demo --skill doc-generator-kis9a

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically generates GoDoc comments, README API sections, Example tests, and updates CHANGELOGs, reducing manual documentation toil.

Core Features & Use Cases

  • GoDoc generation: adds documentation for public functions and types
  • Examples: creates Example tests to verify usage
  • README/API: updates API references in README
  • CHANGELOG: updates changelog with documentation improvements

Quick Start

Run doc-generator on your package to generate docs and examples; verify with go doc and go test.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I auto-generate GoDoc comments for my Go packages?

GoDoc generation automatically creates documentation for exported functions and types in your Go code. Doc-generator analyzes your source and adds properly formatted GoDoc comments following Go conventions, then validates output using go doc.

Can I automatically create example tests from my code?

Yes. Doc-generator creates Example tests that demonstrate usage of your public APIs. These examples are verified with go test to ensure they stay current as your code evolves.

How do I keep my README API section in sync with code changes?

Doc-generator updates README API sections automatically by analyzing your exported identifiers. It maintains consistency between documentation and implementation without manual edits.

Does doc-generator update CHANGELOG entries?

Yes. Doc-generator updates CHANGELOG entries to reflect documentation improvements and API changes, keeping your release notes aligned with generated documentation updates.

What's the workflow for generating docs across multiple Go packages?

Run doc-generator on your package to generate GoDoc comments, README sections, and examples across all exported identifiers. Verify results with go doc and go test before committing.