golang-documentation

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.

Quality

89%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

86%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, actionable documentation skill that delegates detail to real one-level-deep references and provides copy-paste-ready examples. The main gap is light validation/checkpoint explicitness in the writing workflow and minor redundant prose in the principles section.

Suggestions

Add explicit verification checkpoints after the writing steps (e.g. 'Run `go doc ./...` and `go test ./...` to confirm Example tests pass') to strengthen workflow_clarity.

De-duplicate the 'Writing Principles' anti-pattern list against the bullet at line 56 to reduce repetition and tighten conciseness.

Make the in-step references more uniform (some steps link a reference, others inline guidance) so each step clearly signals where the bulk of detail lives.

Dimension	Reasoning	Score
Conciseness	Largely lean with numbered steps, tables, and tight principles, but the 'Writing Principles' section partially restates the anti-pattern list at line 56 and a few generic sentences ('Good documentation makes code discoverable...') are mild padding.	4 / 5
Actionability	Fully executable guidance: a complete copy-paste doc-comment example with parameters/errors/usage, exact README section order with badge markdown, and concrete install commands (go install, curl binary download, docker pull) plus linked templates.	5 / 5
Workflow Clarity	A clearly sequenced 10-step process with a priority-ordered checklist, but validation checkpoints are mostly implicit (e.g. Step 3 mandates doc comments without an inline 'verify with go doc/gofmt' step), leaving minor gaps.	4 / 5
Progressive Disclosure	SKILL.md is a concise overview with well-signaled one-level-deep references (library.md, application.md, code-comments.md, project-docs.md) and templates in assets/templates/, all of which exist as real files; content is appropriately split for easy navigation.	5 / 5
	Total	18 / 20 Passed

Description

92%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong, specific description that names concrete documentation deliverables and gives explicit trigger guidance with a clear Go-specific niche. Minor room to add a few more user-natural synonyms, but it is well above the midpoint overall.

Dimension	Reasoning	Score
Specificity	Lists multiple specific concrete actions and deliverables — 'godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt' — giving comprehensive coverage of what the skill does.	5 / 5
Completeness	Explicitly answers both 'what' (comprehensive Golang documentation guide covering named deliverables) and 'when' via a concrete 'Use when writing or reviewing doc comments...' clause plus 'Triggers for both libraries and applications/CLIs'.	5 / 5
Trigger Term Quality	Strong natural keywords ('doc comments', 'documentation', 'code examples', 'setting up doc sites', 'documentation best practices') that users would say, but a few synonyms and extension-level terms (e.g. '.go', 'godoc') are absent.	4 / 5
Distinctiveness Conflict Risk	Scoped tightly to Golang projects with Go-specific triggers (godoc, Go Playground, Example tests, llms.txt) forming a clear niche with minimal overlap risk against non-Go skills.	5 / 5
	Total	19 / 20 Passed

Validation

87%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 14 / 16 Passed

Validation for skill structure

Criteria	Description	Result
metadata_field	'metadata' should map string keys to string values	Warning
relative_links	Relative link issues: 3 deeper-than-1-level	Warning

	Total	14 / 16 Passed

Repository: samber/cc-skills-golang
Path: skills/golang-documentation/SKILL.md
Commit: 19a0626

Reviewed: 6 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.