Go Package Documenter skill for Claude and Codex
Reference documentation for a Go package that reads like good pkg.go.dev material: an overview, an API reference with every exported symbol explained…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a Go package needs reference docs or a README-style API guide written from its exported functions and types, with examples that compile. Do not use for writing the inline doc comments inside the source, or documenting a REST or GraphQL API. Related topics: coding, package.
What it will ask you for
- Package name and import path (free text, e.g. "ratelimit (github.com/acme/ratelimit)")
- Exported symbols (longer free text)
- Documentation tone (choose one: Formal, Friendly, Concise)
- Include usage examples (choose one: Yes, No)
- Target audience (choose any: Junior developers, Senior engineers, API consumers, DevOps)
- Output format (choose one: Markdown, HTML)
- Version tag (free text, e.g. "v1.2.0")
How it works
- Write the overview naming the package's purpose, its main entry point, and what it does not do, in three to five sentences.
- Document each exported symbol with signature, a go doc style first sentence, parameters, return values, every error, and any concurrency rule, grouped by owning type.
- Write runnable examples for the common path and one error path that compile against the listed signatures, when examples are on.
- Adjust depth per audience selected: getting-started path, stability and error contract, or configuration and observability notes.
- Close with the version note and compatibility line, and mark any symbol lacking information with a TODO rather than a guess.
What you get
A single document in the chosen format with sections Overview, API Reference (grouped by type), Examples when enabled, and Version, each symbol as a heading with its signature in a code block.
What it watches out for
- Starting a symbol's description with 'This function' instead of the symbol name, which breaks the go doc convention readers expect.
- Listing the happy path only and leaving out the errors a function returns, which is the part consumers actually need.
- Documenting symbols that were not supplied, which produces confident references to code that does not exist.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.