golang-documentation

The `golang-documentation` skill provides a structured framework for creating, reviewing, and maintaining documentation for Go projects. It addresses the challenge of ensuring codebases are both human-readable and machine-interpretable, which is critical for developer productivity and collaboration. By consolidating best practices for doc comments, READMEs, CONTRIBUTING guidelines, CHANGELOGs, Go Playground examples, and API documentation, this skill helps teams produce consistent and high-quality documentation across libraries and applications/CLIs.

Key features include automated workflows for writing or reviewing documentation, a comprehensive checklist covering essential documentation artifacts, and guidance for project-specific documentation needs, whether for libraries or applications. The skill supports parallelization through sub-agents, enabling scalable documentation efforts for large codebases. Additional capabilities include integration with Go tools, adherence to godoc conventions, structured example tests, playground demos, and optional generation of `llms.txt` and documentation websites for complex projects.

This skill is ideal for Go developers, technical writers, and AI coding agents working on both open-source and private projects. It serves use cases such as filling missing documentation, auditing existing docs for completeness, preparing code examples for educational purposes, and setting up documentation sites. Its compatibility with AI coding assistants makes it particularly valuable for teams seeking to maintain high documentation standards without extensive manual review.