See assets/doc-template.go when writing doc comments for a new package or exported type and need a complete reference of all documentation conventions.
Works with
AI-first code editor with Composer
Before installing skills in Cursor, ensure your development environment meets these requirements:
node --versiongo-documentationExecute the skills CLI command in your project's root directory to begin installation:
Fetches go-documentation from cxuu/golang-skills and configures it for Cursor.
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate go-documentation. Access via /go-documentation in your agent's command palette.
We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.
Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.
Submit your Claude Code skill and start earning
Automate repetitive workflows and reduce manual effort
Example
Generate reports, summarize documents, draft communications
Save 3-5 hours per week on routine tasks
Learn new skills, understand complex topics, get expert guidance
Example
Explain concepts, provide examples, suggest learning resources
Accelerate learning and skill development by 2x
Enhance output quality through reviews, suggestions, and refinements
Example
Review drafts, suggest improvements, catch errors
Improve work quality by 30-40% with less effort
0
total installs
0
this week
65
GitHub stars
0
upvotes
Run in your terminal
0
installs
0
this week
65
stars
scripts/check-docs.sh — Reports exported functions, types, methods, constants, and packages missing doc comments. Run bash scripts/check-docs.sh --help for options.See
assets/doc-template.gowhen writing doc comments for a new package or exported type and need a complete reference of all documentation conventions.
Normative: All top-level exported names must have doc comments.
// A Request represents a request to run a command.
type Request struct { ...
// Encode writes the JSON encoding of req to w.
func Encode(w io.Writer, req *Request) { ...
Unexported types/functions with unobvious behavior should also have doc comments.
Validation: After adding doc comments, run
bash scripts/check-docs.shto verify no exported symbols are missing documentation. Fix any gaps before proceeding.
Normative: Documentation comments must be complete sentences.
Advisory: Aim for ~80 columns, but no hard limit.
Break based on punctuation. Don't split long URLs.
Group fields with section comments. Mark optional fields with defaults:
type Options struct {
// General setup:
Name string
Group *FooGroup
// Customization:
LargeGroupThreshold int // optional; default: 10
}
Normative: Every package must have exactly one package comment.
// Package math provides basic constants and mathematical functions.
package math
main packages, use the binary name: // The seed_generator command ...doc.go fileRead references/EXAMPLES.md when writing package-level docs, main package comments, doc.go files, or runnable examples.
Advisory: Document non-obvious behavior, not obvious behavior.
| Topic | Document when... | Skip when... |
|---|---|---|
| Parameters | Non-obvious behavior, edge cases | Restates the type signature |
| Contexts | Behavior differs from standard cancellation | Standard ctx.Err() return |
| Concurrency | Ambiguous thread safety (e.g., read that mutates) | Read-only is safe, mutation is unsafe |
| Cleanup | Always document resource release | — |
| Errors | Sentinel values, error types (use *PathError) |
— |
| Named results | Multiple params of same type, action-oriented names | Type alone is clear enough |
Key principles:
ctx.Err() is implied — don't restate itCall Stop to release resources)*PathError) for correct errors.Is/errors.AsRead references/CONVENTIONS.md when documenting parameter behavior, context cancellation, concurrency safety, cleanup requirements, error returns, or named result parameters in function doc comments.
Advisory: Provide runnable examples in test files (
*_test.go).
func ExampleConfig_WriteTo() {
cfg := &Config{Name: "example"}
cfg.WriteTo(os.Stdout)
// Output:
// {"name": "example"}
}
Examples appear in Godoc attached to the documented element.
Read references/EXAMPLES.md when writing runnable Example functions, choosing example naming conventions (Example vs ExampleType_Method), or adding package-level doc.go files.
Read references/FORMATTING.md when formatting godoc headings, links, lists, or code blocks, using signal boosting for deprecation notices, or previewing doc output locally.
| Topic | Key Rule |
|---|---|
| Doc comments | Start with name, use full sentences |
| Line length | ~80 chars, prioritize readability |
| Package comments | One per package, above package clause |
| Parameters | Document non-obvious behavior only |
| Contexts | Document exceptions to implied behavior |
| Concurrency | Document ambiguous thread safety |
| Cleanup | Always document resource release |
| Errors | Document sentinels and types (note pointer) |
| Examples | Use runnable examples in test files |
| Formatting | Blank lines for paragraphs, indent for code |
Example test functions that appear in godocPrerequisites
Time Estimate
15-45 minutes depending on use case complexity
Steps
Common Pitfalls
✓ Do
✗ Don't
💡 Pro Tips
✓ Use when
Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.
✗ Avoid when
Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.
sammcj/agentic-coding
jwynia/agent-skills
mindrally/skills
kostja94/marketing-skills
github/awesome-copilot
wispbit-ai/skills
We added go-documentation from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.
go-documentation is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
go-documentation fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
Registry listing for go-documentation matched our evaluation — installs cleanly and behaves as described in the markdown.
I recommend go-documentation for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.
go-documentation reduced setup friction for our internal harness; good balance of opinion and flexibility.
Useful defaults in go-documentation — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.
Solid pick for teams standardizing on skills: go-documentation is focused, and the summary matches what you get after install.
go-documentation is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
Registry listing for go-documentation matched our evaluation — installs cleanly and behaves as described in the markdown.
showing 1-10 of 37