skills.rest
adibfirman
adibfirmanCOMMUNITY
Explore all skills by this author →
Website𝕏@adibfirman_GitHub

golang-documentation

Generate and audit Go project documentation including godoc comments and README sections.

2|Updated Feb 12, 2024
Search Tags:#changelog#documentation#readme#go#contributing#ai-ready#godoc
One-click install
npx skills add https://github.com/adibfirman/dotfiles --skill golang-documentation-adibfirman
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: golang-documentation
Source: https://github.com/adibfirman/dotfiles/tree/main/claude/.claude/skills/technical/golang/golang-documentation
Command: npx skills add https://github.com/adibfirman/dotfiles --skill golang-documentation-adibfirman

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It helps you create and review high-quality documentation for Go libraries and applications so readers can understand the code quickly and tools (including AI coding agents) can discover and use it correctly.

Core Features & Use Cases

  • Doc comments that explain why/when/constraints: Produces godoc-ready exported function and method comments that go beyond restating the signature.
  • README, CONTRIBUTING, and CHANGELOG guidance: Ensures the right section order, the right depth, and consistent project-delivery documentation patterns.
  • Library-ready examples: Encourages ExampleXxx test functions and Go Playground demos for public packages, including llms.txt for AI accessibility.

Use it when writing or reviewing doc comments, README/contributor docs, or API-related documentation for a Go project (library, CLI, or both).

Quick Start

Instruct your agent: Review my Go package documentation (godoc comments and README) and rewrite the missing sections to match the required Go documentation checklist and README section order.

Frequently Asked Questions about golang-documentation

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

FAQPage Schema
How do I write godoc comments that explain why and when instead of just restating the function signature?▼

Generate godoc comments for exported Go functions that explain the why, when, and constraints rather than restating the signature. This produces documentation that helps human readers and AI agents understand and use your API correctly.

What is the correct section order for a Go project README and contributor documentation?▼

Follow a prescribed README section order and consistent project-delivery documentation patterns for your CONTRIBUTING and CHANGELOG files. This ensures the right depth and structure so readers can understand your Go project quickly.

How do I make my Go library examples accessible and discoverable for AI coding agents?▼

Add an llms.txt file and verified ExampleXxx test functions with optional Go Playground links to your public Go packages. This generates AI-accessible examples that help AI coding agents discover and use your library correctly.

Can I use this to audit existing documentation for a Go CLI application?▼

Yes, you can audit existing documentation for Go libraries and CLI applications against a required documentation checklist. It reviews your godoc comments and README sections, then rewrites missing parts to match the expected structure and depth.

What should I include in a Go package CONTRIBUTING guide to ensure high-quality documentation?▼

Include consistent project-delivery documentation patterns and the right depth of guidance for contributors. This ensures they follow the prescribed README section ordering and write godoc comments that accurately explain why, when, and constraints.

Related Skills

Explore More Content & Communication Skills→
kis9akis9a

doc-generator

Generate and update Go documentation from source code.

Community
Advanced
Utchash007Utchash007

golang-documentation

Organize Go documentation best practices into reusable templates and workflows.

Community
Advanced
cxuucxuu
139

go-documentation

Standardize Go doc comments, package docs, and godoc formatting.

Community
Advanced
hellopoisonxhellopoisonx
4

golang-documentation

Write and review Go documentation with godoc conventions and structured checklists.

Community
Advanced