go-documentation

go-documentation is a skill for Claude Code, Codex from TypeFox/agent-skills. It costs 98 tokens per session (3,753 once invoked), scanned A, original, MIT.

A guide to writing Go documentation comments, the comments used by Go’s tools and the pkg.go.dev website to describe packages and exported code.

In plain words
What is it for?
Writing package comments and doc.go files, documenting exported functions and types, adding runnable examples, marking deprecated APIs, and debugging module documentation on pkg.go.dev.
Why use it?
It prevents documentation from being ignored or rendered incorrectly because it follows habits from JSDoc or Markdown that Go does not support.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/typefox/agent-skills/go-documentation
Any agent
npx skills add TypeFox/agent-skills --skill go-documentation
Clone the repo
git clone --depth 1 https://github.com/TypeFox/agent-skills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for go-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/typefox/agent-skills/go-documentation.svg)](https://agentmods.dev/skills/typefox/agent-skills/go-documentation)
Your own site
<a href="https://agentmods.dev/skills/typefox/agent-skills/go-documentation"><img src="https://agentmods.dev/badge/skills/typefox/agent-skills/go-documentation.svg" alt="Measured on agentmods" height="20"></a>
Per session 98 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,753 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00098 $0.03753
Opus 5 $0.00049 $0.01877
Sonnet 5 $0.00020 $0.00751
Haiku 4.5 $0.00010 $0.00375

Measured 3d ago against content hash 1f90eada55b4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

go-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/go-documentation/SKILL.md · 256 lines

How it starts

The opening of the file, as written. The whole thing — 256 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Go Documentation

Go treats documentation as part of the toolchain. go doc reads comments locally, pkg.go.dev publishes them, and gofmt normalizes their markup. The conventions here come from the official spec at https://go.dev/doc/comment — tools depend on them, so they are not stylistic preferences.

Coming from TypeScript

A Go doc comment is a plain // comment above a declaration — there are no tags, and almost none of the Markdown that JSDoc/TSDoc allow. These are the habits that silently produce wrong or unrendered docs; reach for the Go column instead.

TypeScript / JSDoc habit What Go actually does
@param, @returns, @throws tags No tags exist. Name params and results in prose ("It returns the number of bytes written"). Types are in the signature — don't restate them.
`inline code` backticks Backticks (and 'single quotes') render as curly ‘quotes’. There is no inline-code markup — use a doc link [Name] for a symbol, plain text otherwise.
Markdown link [text](url) Not a link. Use a bare URL, or reference style: [text] in prose plus [text]: https://… defined at the end of the comment.
{@link Foo} cross-reference Not recognized, renders as literal text. Use a doc link: [Foo].
Fenced ``` blocks, **bold** No fences, no emphasis. A code block is any line indented by one tab; **bold** renders literally.
/** ... */ Javadoc-style block comment Valid Go syntax, and it does attach as the doc comment — but gofmt recognizes the leading-* pattern and deliberately leaves it untouched, so the un-stripped * on every line makes go doc/pkg.go.dev render it as a mangled code block. Use a plain // on every line instead.
@example with a snippet Examples are real compiled functions (func ExampleFoo()) in _test.go, run by go test. See references/examples.md.
@deprecated A paragraph beginning with the exact prefix Deprecated: .
Summary in any phrasing The first sentence must start with the symbol name: Foo returns…, Package foo… (see the table below).
README is the docs (npmjs.com) pkg.go.dev and go doc show the package comment, in addition to the README, above the API.
Indent comment text freely Any indented line becomes a code block. Keep prose flush left.

Read the full file on GitHub · 256 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 256 lines · 98 tokens per session scan A 1f90eada55b4

Subscribe to this mod's changes

go-documentation is a skill published in the GitHub repository TypeFox/agent-skills (5 stars, last pushed 4d ago), licensed MIT. It adds 98 tokens to every session and 3,753 once invoked, about $0.0005 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

gen-test

Generate idiomatic tests for Go packages and handlers in the Meshery project.

meshery/meshery · 18 tokens

golang-testing

Production-ready Golang tests — table-driven tests, testify suites and mocks, parallel tests, fuzzing, fixtures, goroutine leak detection with goleak, snapshot testing, code coverage, integration tests, idiomatic test naming. Use when writing or reviewing Go tests, choosing a testing approach, setting up Go test CI…

samber/cc-skills-golang · 115 tokens

golang-cli

Golang CLI application development. Use when building, modifying, or reviewing a Go CLI tool — especially for command structure, flag handling, configuration layering, version embedding, exit codes, I/O patterns, signal handling, shell completion, argument validation, and CLI unit testing. Also triggers when code uses…

samber/cc-skills-golang · 126 tokens

golang-code-style

Golang code style conventions — line length and breaking, variable declarations, control flow clarity, when comments help vs hurt. Use when writing or reviewing Go code, asking about style or clarity, or establishing project coding standards. Not for naming conventions (→ See samber/cc-skills-golang@golang-naming…

samber/cc-skills-golang · 116 tokens

golang-samber-oops

Structured error handling in Golang with samber/oops — error builders, stack traces, error codes, error context, error wrapping, error attributes, user-facing vs developer messages, panic recovery, and logger integration. Apply when using or adopting samber/oops, or when the codebase already imports…

samber/cc-skills-golang · 74 tokens

golang-uber-dig

Implements dependency injection in Golang using uber-go/dig — reflection-based container, Provide/Invoke, dig.In/dig.Out parameter and result objects, named values, value groups, optional dependencies, scopes, and Decorate. Apply when using or adopting uber-go/dig, when the codebase imports go.uber.org/dig, or when…

samber/cc-skills-golang · 111 tokens