skills.rest
dennisonbertram
dennisonbertramCOMMUNITY
Explore all skills by this author →
Website𝕏@DennisonBertramGitHub

doc-generation

Generate Go documentation, OpenAPI specs, and README templates.

1|1|Updated Mar 6, 2026
Search Tags:#documentation#openapi#readme#go#swagger#godoc
One-click install
npx skills add https://github.com/dennisonbertram/go-agent-harness --skill doc-generation-dennisonbertram
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generation
Source: https://github.com/dennisonbertram/go-agent-harness/tree/main/skills/doc-generation
Command: npx skills add https://github.com/dennisonbertram/go-agent-harness --skill doc-generation-dennisonbertram

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation and curation of Go documentation, OpenAPI specs, and README templates, helping teams keep accurate, up-to-date docs with less manual effort.

Core Features & Use Cases

  • godoc generation for Go packages and types, with optional site-style rendering for local review.
  • OpenAPI / swagger generation using swaggo for APIs exposed by the project, including endpoint-level annotations.
  • README skeleton and project-level docs generation to accelerate onboarding and knowledge transfer, with versioned outputs for release notes.

Quick Start

Generate documentation for a target Go package or module, run godoc locally, and produce an OpenAPI spec and README template in one workflow.

Frequently Asked Questions about doc-generation

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

FAQPage Schema
How do I generate OpenAPI specs from a Go project?▼

OpenAPI specs are generated by invoking swaggo tooling to parse endpoint-level annotations, producing structured swagger documentation with versioned metadata for your Go APIs.

Can I generate godoc documentation and README templates together?▼

Yes, you can generate godoc rendering for packages and template-based README skeletons in one workflow, producing versioned outputs to accelerate project onboarding and knowledge transfer.

What is the best way to automate Go documentation for large projects?▼

Automating Go documentation involves parsing package sources and invoking godoc tooling to emit structured docs, supporting Go projects of any size with versioned metadata.

Does this approach work with swaggo for swagger generation?▼

Yes, it supports swaggo-based OpenAPI generation by parsing API source code and producing structured swagger specs with endpoint-level annotations and versioned metadata.

How do I create README skeletons for multiple Go modules?▼

README skeletons are created using template-based generation for modules and packages, producing structured project-level docs that accelerate onboarding and code comprehension.

Why does godoc generation require parsing package sources?▼

Godoc generation requires parsing package sources to extract types and structures accurately, ensuring the emitted documentation reflects the current codebase with valid versioned metadata.

Related Skills

Explore More Software Engineering Skills→
ozan-fnozan-fn

golang-swagger

Generate Swagger/OpenAPI documentation from Go code annotations.

Community
Advanced
DauQuangThanhDauQuangThanh
14

technical-writing

Generate API documentation, user guides, tutorials, and technical specifications.

Community
Advanced
sambersamber
2.9k

golang-lint

Configure and run golangci-lint to analyze Go projects and interpret results.

Community
Advanced
Sanali209Sanali209

code-documenter

Generate and validate documentation for Python, TypeScript, and API-spec projects.

Community
Advanced