golang-documentation

Create and review documentation for Golang projects with examples and guidelines.

Updated May 30, 2026
One-click install
npx skills add https://github.com/ozan-fn/mqtt-capture --skill golang-documentation-ozan-fn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: golang-documentation
Source: https://github.com/ozan-fn/mqtt-capture/tree/main/.agents/skills/golang-documentation
Command: npx skills add https://github.com/ozan-fn/mqtt-capture --skill golang-documentation-ozan-fn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires go, golangci-lint, git, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating and maintaining high-quality documentation for Golang projects, offering guidelines and examples for various documentation components.

Core Features & Use Cases

  • Documentation Guidelines: Provides detailed guidelines for writing doc comments, README, CONTRIBUTING, CHANGELOG, and other documentation components.
  • Example Test Functions: Offers examples for writing effective test functions that serve as executable documentation.
  • Playground Demos: Links to Go Playground examples for easy experimentation and understanding.
  • Use Case: Ideal for Go developers and technical writers looking to improve their documentation practices, ensuring clarity, accuracy, and maintainability.

Quick Start

Invoke the golang-documentation skill to generate or review documentation for your Go project.

Frequently Asked Questions about golang-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a CONTRIBUTING and CHANGELOG file for my Golang project?

To generate a CONTRIBUTING and CHANGELOG file for a Golang project, use this skill to apply standardized documentation guidelines and examples for various project components. It provides detailed rules for writing these files.

What are the best practices for writing doc comments in Go?

Best practices for writing doc comments in Go involve following specific guidelines that ensure clarity, accuracy, and maintainability. This skill offers comprehensive rules and examples for creating effective doc comments.

Do I need golangci-lint installed to review Golang documentation?

Yes, you need golangci-lint installed to review Golang documentation with this skill. The environment requires go, golangci-lint, and git to function properly and execute documentation checks.

Can I use example test functions as executable documentation in Go?

Yes, you can use example test functions as executable documentation in Go. This skill provides examples for writing effective test functions that serve as clear, executable references for your codebase.

How to add Go Playground demos to a README file?

To add Go Playground demos to a README file, you can use this skill to link to Go Playground examples for easy experimentation. It streamlines the process of including interactive demonstrations in your documentation.