golang-documentation
Comprehensive documentation guide for Golang projects, covering godoc comments
by samberFree
Description
golang-documentation is an agent skill from the samber cc-skills-golang collection that guides a coding agent in writing and reviewing documentation for Go projects. It treats documentation as a first-class deliverable that should serve both humans and AI agents, and it is written for a reader who has never seen the codebase before. The skill covers godoc comments, the README, CONTRIBUTING and CHANGELOG files, runnable examples in Go Playground and example tests, API documentation, and an llms.txt file for AI tools. It has two modes. Write mode generates or fills in missing documentation, working through a checklist in order or in parallel across packages or files with sub-agents. Review mode audits existing documentation for completeness, accuracy and style, using up to five parallel sub-agents, one for each documentation layer: doc comments, README, CONTRIBUTING, CHANGELOG and library-specific extras. The skill includes cross-references to related skills in the collection. It is listed on skills.sh, where the page shows install counts, GitHub stars and security audit results, all passing. Install it with npx skills add https://github.com/samber/cc-skills-golang --skill golang-documentation.…
Highlights
- Godoc comments and README guidance
- CONTRIBUTING and CHANGELOG files
- Example tests and Go Playground examples
- llms.txt for AI tools
- Write and review modes
- Installs from skills.sh
Ratings & Reviews
No ratings yet
Be the first to rate golang-documentation.
People also visit
readme-blueprint-generator
Automated README generation by analyzing project documentation structure
code-documentation
The user requests to generate, create, or improve documentation for code, APIs
go-concurrency-patterns
Master Go concurrency with goroutines, channels, sync primitives, and context
golang-documentation FAQ
What does this skill cover?
Documentation for Go projects: godoc comments, README, CONTRIBUTING, CHANGELOG, example tests, Go Playground examples, API docs and llms.txt.
What does review mode do?
It audits existing docs for completeness, accuracy and style, with one sub-agent per documentation layer.
Who is the documentation for?
Both humans and AI agents, written for a reader who has never seen the codebase.
How do I install it?
Run npx skills add https://github.com/samber/cc-skills-golang --skill golang-documentation.
What are the security audit results?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Pass.
How popular is it?
The page shows about 38.6K installs, and the cc-skills-golang repository has 3.5K GitHub stars.
What are the best golang-documentation alternatives?
Popular alternatives to golang-documentation include readme-blueprint-generator, code-documentation and context-driven-development. See all golang-documentation alternatives