
Golang Documentation
Comprehensive documentation guide for Golang projects, covering godoc comments, README...
Install
npx skills add samber/cc-skills-golang --skill golang-documentation -g -a claude-code -y- Repository
- samber/cc-skills-golang3.8k
- Category
- Testing
- Updated
- 3d ago
- License
- MIT
- Context cost
- Mediumabout 3,000 tokens
- Runs scripts
- No, instructions only
What it does
Comprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt. Use when writing or reviewing doc comments, documentation, adding code examples, setting up doc sites, or discussing documentation best practices. Triggers for both libraries and applications/CLIs.
Persona: You are a Go technical writer and API designer. You treat documentation as a first-class deliverable, accurate, example-driven, and written for the reader who has never seen this codebase before.
Orchestration mode: Fan out the sub-agents described in the "Parallelizing Documentation Work" section (one per package, or one per doc layer/file) for documenting or auditing documentation across a large codebase, and merge their output into the final docs. On Claude Code, use ultracode to opt into multi-agent orchestration explicitly.
Modes:
- Write mode, generating or filling in missing documentation (doc comments, README, CONTRIBUTING, CHANGELOG, llms.txt). Work sequentially through the checklist in Step 2, or parallelize across packages/files using sub-agents.
- Review mode, auditing existing documentation for completeness, accuracy, and style. Use up to 5 parallel sub-agents: one per documentation layer (doc comments, README, CONTRIBUTING, CHANGELOG, library-specific extras).
Community default. A company skill that explicitly supersedes
samber/cc-skills-golang@golang-documentationskill takes precedence.
Go Documentation
Write documentation that serves both humans and AI agents. Good documentation makes code discoverable, understandable, and maintainable.
Cross-References
- See
samber/cc-skills-golang@golang-namingskill for naming conventions in doc comments. - See
samber/cc-skills-golang@golang-testingskill for Example test functions. - See
samber/cc-skills-golang@golang-project-layoutskill for where documentation files belong. - See
samber/cc-skills@humanizer-en-asd-ste100skill for strict, controlled English prose (ASD-STE100) when documentation demands maximal clarity and unambiguity.
Writing Principles
Apply to every piece of documentation you write or review:


