go-documentation

Community

Write clear, idiomatic Go docs with confidence.

Authorcxuu
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Documentation quality for Go code is often inconsistent across projects. This skill provides comprehensive guidelines for writing clear, consistent doc comments, package docs, and godoc formatting to improve readability and maintainability.

Core Features & Use Cases

  • Establishes norms for doc comments in exported names, including capitalization and sentence structure.
  • Guides proper godoc formatting, package comments, and runnable examples to improve documentation quality.
  • Useful for code reviews and onboarding, ensuring new contributors follow a single standard when documenting Go code.

Quick Start

Apply these Go documentation guidelines when writing or reviewing Go packages, types, or functions.

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: go-documentation
Download link: https://github.com/cxuu/golang-skills/archive/main.zip#go-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 223,000+ vetted skills library on demand.