PlugWiki

golang-documentation Skill (samber): What It Does and How to Install It

Makes Claude write and review Go documentation: doc comments, example tests, README, CONTRIBUTING, CHANGELOG, API docs and llms.txt.

Installs
41.2K
on skills.sh
Stars
3.7K
on GitHub
Files
9
besides SKILL.md
Updated
Nov 2026
last repo commit

golang-documentation makes Claude treat docs as a deliverable. It first detects whether your project is a library or an application, then works through a documentation checklist and fills the gaps from four templates: README, CONTRIBUTING, CHANGELOG and llms.txt. It runs in write mode or review mode, and can fan out sub-agents across packages or doc files on a large codebase. The frontmatter also allows WebFetch.

Good for

  • Go library authors who need godoc comments, Example functions and a README
  • Teams documenting a Go service or CLI with install, config and API docs
  • Claude Code and Codex users on Go projects

Install golang-documentation

Claude Code

  1. 1

    Copy this prompt.

    Install the golang-documentation skill in Claude Code. Run this command:
    
    /plugin marketplace add samber/cc
    /plugin install cc-skills-golang@samber
    
    Then check that it loaded and tell me how to use it.
  2. 2

    Paste it into Claude Code. It shows the change and asks before running it.

The README says these skills are built as atomic, cross-referencing units, and that installing only a subset gives a partial and potentially inconsistent view of the guidelines. It recommends installing all the general-purpose skills together, which the plugin does. Its manifest lists no hooks or MCP servers, and the repo holds 46 skills. Use the skills CLI line only if you want just this one. Pick one route, not both.

From the project README. Source.

What's in the skill

When it loads

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.

Sections in SKILL.md

  1. Cross-References
  2. Writing Principles
  3. Step 1: Detect Project Type
  4. Step 2: Documentation Checklist
  5. Parallelizing Documentation Work
  6. Step 3: Function & Method Doc Comments
  7. Step 4: README Structure
  8. Step 5: CONTRIBUTING & Changelog
  9. Step 6: Library-Specific Documentation
  10. Step 7: Application-Specific Documentation
  11. Step 8: API Documentation
  12. Step 9: AI-Friendly Documentation
  13. Step 10: Delivery Documentation

Key facts

Author
samber
License
MIT
Skill version
1.3.2
Installs on skills.sh
41,238 (Nov 2, 2026)
Last repo commit
Nov 1, 2026

What it includes

  • Generates or fills in missing doc comments, README, CONTRIBUTING, CHANGELOG and llms.txt

    Works sequentially through the checklist in Step 2, or parallelizes across packages and files with sub-agents.

    Write · Write mode

  • Audits existing docs for completeness, accuracy and style with up to 5 sub-agents

    One sub-agent per documentation layer: doc comments, README, CONTRIBUTING, CHANGELOG and library-specific extras.

    Read · Review mode

  • Decides library or application, which changes what documentation is needed

    Step 1: Detect Project Type

  • A 13-row table of required and recommended docs, for libraries and for applications

    Step 2: Documentation Checklist

  • Every exported function needs a comment that starts with its name and says why and when

    Step 3: Doc Comments

  • A nine-part README order, copied from templates/README.md

    Write · Step 4: README Structure

  • A contributor guide for a setup under 10 minutes, plus a Keep a Changelog file

    Write · Step 5: CONTRIBUTING & Changelog

  • Adds Go Playground links, ExampleXxx test functions, pkg.go.dev rendering and a docs site

    Step 6: Library docs

  • Covers install methods, CLI help text and configuration docs

    Step 7: Application docs

  • Picks OpenAPI, AsyncAPI or Protobuf by API style

    Step 8: API Documentation

  • Adds a llms.txt file at the repository root from the template

    Write · Step 9: AI-Friendly Documentation

  • Documents how users get the project: go get, release binaries, go install, Docker

    Step 10: Delivery Documentation

From the official docs

Permissions

Low risk

It lets Claude write and rewrite documentation files and Go comments in your project and run go, golangci-lint and git commands.

What it can do

  • Read your data
  • Create and change things
  • Delete things
  • Read-only mode

Watch out for

  • It edits Go files and runs go and git commands

    The frontmatter allows Edit, Write and Bash for go, golangci-lint and git. Work on a branch and read the diff before you commit.

  • It writes project docs and can fetch web pages

    It creates or rewrites README, CONTRIBUTING, CHANGELOG and llms.txt, and WebFetch is among its allowed tools. Review the files before you commit them.

  • Review mode runs up to five sub-agents

    Each reads a different documentation layer. Expect several agents reading your repository at once.

Security advisories

No published security advisories as of Nov 2, 2026.

Technical details
Turning on read-onlyNo read-only setting is documented in SKILL.md.
Talks toYour AI provider receives the Go code and command output Claude reads
Sign-in and keysSKILL.md names no account or API key.
Scopes
  • Claude edits Go files and writes README, CONTRIBUTING, CHANGELOG and llms.txt

  • Claude runs go, golangci-lint and git commands

  • WebFetch is an allowed tool

Questions

How do I install golang-documentation?

Use the install box above. The plugin route installs the whole Go skill set (46 skills in the repo), and the skills CLI route installs only this skill. Pick one so you do not get every skill twice. The README says these skills cross-reference each other and installing a subset gives a partial view.

Does golang-documentation work in the Claude app?

The README documents no Claude app install, so the Claude tab in the install box is our generic zip-upload route, not a documented one. The skill reads and edits Go files and runs go commands on your machine, so Claude Code or Codex is the better fit.

Does golang-documentation need an API key?

SKILL.md names no API key or account. It does need Go installed on your machine.

Is golang-documentation safe to run?

It edits your Go files and runs go, golangci-lint and git commands in your project, so work on a branch and read the diff before you commit. The skill bundles no scripts: its other files are reference guides and an evals/evals.json file.

What documentation files does golang-documentation create?

README.md, CONTRIBUTING.md, CHANGELOG.md and llms.txt, each from a template bundled with the skill, plus Go doc comments and Example test functions. The checklist marks which are required and which are recommended for a library or an application.

Does it work for applications, or only libraries?

Both. Step 1 detects whether you have a library or an application or CLI. Libraries get godoc, Example functions and Playground links; applications get install methods, CLI help text and configuration docs.

Information

updated Nov 2, 2026

Folder
skills/golang-documentation

samber/cc-skills-golangskills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 7
  1. cc-skills-golang · github.com
  2. cc-skills-golang README · github.com
  3. plugin.json · github.com
  4. skills CLI commands · github.com
  5. README.md#-how-to-use · github.com
  6. golang-documentation SKILL.md · github.com
  7. golang-documentation on skills.sh · skills.sh

Updated Nov 2, 2026.