domains / families / documents / golang-documentation

golang-documentation

separate

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.

When to use

• writing or reviewing doc comments
• writing or reviewing documentation
• adding code examples
• setting up doc sites
• discussing documentation best practices
• documenting libraries
• documenting applications/CLIs
• auditing existing documentation

When not to use

• naming conventions in doc comments
• Example test functions
• where documentation files belong
• strict, controlled English prose (ASD-STE100)

Skill page

Source