Go Documentation
CheckedHelps with Go, documentation as part of writing, documentation, and content creation workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add cxuu/golang-skills --skill go-documentation -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
cxuu
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned cxuu/golang-skills at 91f0c2eef5.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 91f0c2eef5
- Manifest
- skills/go-documentation/SKILL.md
- Scanned
- 7 files, 1,046 lines
About this skill
go-documentation
What it does
This skill enables AI agents to automatically generate, update, and maintain comprehensive documentation specifically for Go (Golang) projects. It parses source code to extract function signatures, comments, and usage patterns into structured markdown or standard doc formats.
When to use it
- Onboarding new developers: Quickly create a reference guide so team members can understand the codebase without reading every file.
- API maintenance: Automatically regenerate API documentation whenever functions are modified or new endpoints are added.
- Code review support: Generate summary docs for complex modules before they are merged into the main branch.
- External integration: Produce clean, formatted documentation files to share with third-party developers or clients.
Key capabilities
- Parses Go source code to identify functions, methods, and structs.
- Extracts existing comments and docstrings to build coherent narratives.
- Outputs documentation in standard markdown format ready for deployment.
- Maintains consistency in formatting across large codebases.
Example prompts
- "Generate a complete README.md file for my Go project using the
go-documentationskill." - "Update the documentation for the
authpackage based on recent changes in the source code." - "Create a structured API reference guide from the functions defined in
handlers.go."
Tips & gotchas
Ensure your Go code includes clear comments or docstrings, as the skill relies heavily on these to generate accurate descriptions. For best results, run this skill after significant refactoring to keep documentation synchronized with the latest logic.