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

86%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Critical

Do not install without reviewing

Quality

Content

72%

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 with strong progressive disclosure via real reference files. The main gaps are a slightly long inline code example/badge block and missing explicit validation feedback loops for audit and batch edits.

Suggestions

Tighten the large inline doc-comment example and the full badge markdown block — link to a template/reference instead of inlining the complete block to improve token efficiency.

Add explicit validate→fix→retry checkpoints to Review mode and batch documentation edits (e.g., run golangci-lint/go vet, verify godoc renders, re-check after fixes) to earn a higher workflow_clarity score.

De-duplicate the README section list versus the templates/README.md reference to avoid restating the same structure in two places.

Dimension	Reasoning	Score
Conciseness	The body is largely lean and directive, but the full inline doc-comment example (~30 lines), the complete badge markdown block, and some table/section repetition add tokens beyond the minimum needed — mostly efficient but could be tightened.	2 / 3
Actionability	Provides copy-paste-ready code (doc-comment format, badge markdown, delivery commands), a concrete README section order, and an API-style/tool table — fully executable, specific guidance.	3 / 3
Workflow Clarity	Steps 1–10 are clearly sequenced with a priority checklist and parallelization guidance, but there are no explicit validate→fix→retry checkpoints for the Review-mode audit or batch/destructive doc edits, which the rubric caps at 2.	2 / 3
Progressive Disclosure	SKILL.md is a clear overview with well-signaled, one-level-deep references to references/.md and assets/templates/ (all verified to exist), splitting detail appropriately for easy navigation.	3 / 3
	Total	10 / 12 Passed

Description

100%

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 with explicit "Use when" triggers and a clear Go-documentation niche. It enumerates concrete documentation layers and natural trigger phrases, leaving little ambiguity about when to invoke it.

Dimension	Reasoning	Score
Specificity	Lists many concrete documentation layers and actions — "godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt" plus "writing or reviewing doc comments... adding code examples, setting up doc sites" — matching the anchor for multiple specific concrete actions.	3 / 3
Completeness	Explicitly states what it covers (the layer list) and includes an explicit "Use when..." trigger clause plus "Triggers for both libraries and applications/CLIs", answering both what and when.	3 / 3
Trigger Term Quality	Natural user phrasings are well covered: "writing or reviewing doc comments", "documentation", "adding code examples", "setting up doc sites", and "discussing documentation best practices" — terms a user would plausibly say.	3 / 3
Distinctiveness Conflict Risk	Scoped specifically to Golang documentation with a clear niche (libraries vs applications/CLIs); unlikely to trigger for unrelated skills.	3 / 3
	Total	12 / 12 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: 4158351

Reviewed: about 14 hours 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.