golang-documentation

Installation
SKILL.md

Adapted from samber/cc-skills-golang@golang-documentation. Pair with golang-common-practice for shared verification guidance.

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.

Modes:

  • Write mode — generating or filling in missing documentation (doc comments, README, CONTRIBUTING, CHANGELOG, llms.txt). Work through the applicable checklist in Step 2.
  • Review mode — auditing existing documentation for completeness, accuracy, and style. Cover every applicable documentation layer (doc comments, README, CONTRIBUTING, CHANGELOG, library-specific extras).

Go Documentation

Write documentation that serves both humans and AI agents. Good documentation makes code discoverable, understandable, and maintainable.

Cross-References

See golang-naming skill for naming conventions in doc comments. See golang-testing skill for Example test functions.

Writing Principles

Apply to every piece of documentation you write or review:

Installs
11
Repository
bateau84/skills
First Seen
13 days ago