skills.rest
samber
samberCOMMUNITY
Explore all skills by this author →
Website𝕏@samuelbertheGitHub

golang-documentation

Design Go documentation workflows for godoc, README, CHANGELOG, and llms.txt artifacts.

2.9k|191|Updated Mar 21, 2026
Search Tags:#documentation#readme#golang#llms.txt#playground#godoc#example-tests
One-click install
npx skills add https://github.com/samber/cc-skills-golang --skill golang-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: golang-documentation
Source: https://github.com/samber/cc-skills-golang/tree/main/skills/golang-documentation
Command: npx skills add https://github.com/samber/cc-skills-golang --skill golang-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about golang-documentation

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

FAQPage Schema
How do I generate consistent godoc and README files for a Golang library?▼

To generate consistent godoc and README files for a Golang library, design a documentation workflow using frontmatter-driven metadata, proper godoc-style comments, and Example tests to ensure maintainability and automated discovery.

What is the best way to structure Go documentation for both CLIs and libraries?▼

The best way to structure Go documentation for CLIs and libraries is to apply a unified approach that produces standardized godoc comments, README outlines, CHANGELOGs, and AI-friendly llms.txt artifacts across exported APIs.

How do llms.txt artifacts improve Go project documentation?▼

llms.txt artifacts improve Go project documentation by providing AI-friendly metadata that enables knowledge portability for AI agents, ensuring your architecture decisions and exported APIs are easily discoverable by automated tooling.

Can I use Example tests to generate documentation for multiple Golang packages?▼

Yes, you can use Example tests to generate documentation for multiple Golang packages by applying a standardized documentation workflow that spans exported APIs, package docs, and release workflows across the entire project.

When do I need ADRs and architecture docs for a Go application?▼

You need ADRs and architecture docs for a Go application when your project involves complex architecture decisions, requiring you to document these decisions alongside standard README, CHANGELOG, and godoc artifacts for comprehensive maintainability.

Related Skills

Explore More Software Engineering Skills→
QunnnnQunnnn

go-documentation

Write idiomatic godoc comments, READMEs, and example tests for Go packages.

Community
Intermediate
omarluqomarluq
5

golang-documentation

Generate Go project documentation with godoc comments, README templates, and llms.txt.

Community
Advanced
finlaysonstudiofinlaysonstudio
2

prepare

Automate release preparation for multi-package JavaScript projects with coordinated commits and version bumps.

Official
Intermediate
haipham22haipham22
2

golang-documentation

Audit and write Go documentation following godoc and llms.txt conventions.

Community
Advanced