golang-documentation

Community

Go docs that shine for libraries and CLIs.

Authorsamber
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Go projects often suffer from inconsistent and hard-to-maintain documentation across libraries and CLIs. This guide provides a unified approach to writing godoc comments, package docs, README, CHANGELOGs, and AI-friendly metadata to improve discoverability and maintainability.

Core Features & Use Cases

  • Standardized frontmatter-driven metadata for each Skill unit to enable automated discovery and tooling.
  • Comprehensive guidance on exporting doc comments, Example tests, README, llms.txt, and optional architecture and ADR documentation.
  • Strategies for both libraries and applications, including playgrounds, documentation websites, and knowledge portability for AI agents.

Quick Start

Create a complete documentation plan for a new Go library, including frontmatter, README outline, and Example tests.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: golang-documentation
Download link: https://github.com/samber/cc-skills-golang/archive/main.zip#golang-documentation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.