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

87%

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

78%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 guide that keeps the body lean while pushing detail into one-level-deep reference and template files. Its main weakness is the absence of explicit documentation-validation checkpoints (e.g., verify examples compile, run `go doc` to preview) framed into the workflow.

Suggestions

Remove the filler opener 'Good documentation makes code discoverable, understandable, and maintainable.' — it adds no actionable guidance.

Add an explicit validation checkpoint to the workflow (e.g., a 'Verify' step: run `go doc ./...` to preview, run `go test` to confirm Example functions compile and pass).

Trim the long CalculateDiscount doc-comment example or move the full annotation format to references/code-comments.md, keeping only a minimal illustrative snippet inline.

Dimension	Reasoning	Score
Conciseness	The body is mostly lean and does not explain basic Go concepts, but the opening platitude ('Good documentation makes code discoverable, understandable, and maintainable.') and a fairly long worked doc-comment example are minor over-explanation that could be trimmed.	4 / 5
Actionability	Provides concrete, copy-paste-ready guidance (numbered README section order, badge markdown template, delivery install commands, full doc-comment example), but several sections defer specifics to reference files, leaving minor gaps.	4 / 5
Workflow Clarity	A clear 10-step sequence (detect project type through delivery) with parallelization guidance, and implicit validation via `go doc`/`go test`, but no explicit validate-then-fix checkpoints framed into the workflow.	4 / 5
Progressive Disclosure	SKILL.md is a clean overview with well-signaled, one-level-deep references to real files (references/.md with section anchors, assets/templates/) that all exist, with content appropriately split and easy to navigate.	5 / 5
	Total	17 / 20 Passed

Description

96%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 clearly states both what the skill covers and when to trigger it, with concrete artifacts and natural trigger terms. Minor overlap risk with sibling Go skills prevents a perfect distinctiveness score.

Dimension	Reasoning	Score
Specificity	Lists many concrete artifacts (godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, llms.txt) and concrete actions (writing/reviewing, adding code examples, setting up doc sites), giving comprehensive coverage.	5 / 5
Completeness	Explicitly states what the skill does ('Comprehensive documentation guide for Golang projects, covering...') and when to use it ('Use when writing or reviewing doc comments...'), with concrete trigger phrases.	5 / 5
Trigger Term Quality	Includes natural user phrasings (doc comments, documentation, code examples, doc sites) plus file-name synonyms (README, CHANGELOG, llms.txt), comparable in breadth to the comprehensive-coverage anchor.	5 / 5
Distinctiveness Conflict Risk	Scoped to Golang documentation with distinct triggers, but acknowledged sibling skills (golang-naming, golang-testing) create minor overlap risk, keeping it just below minimal-conflict.	4 / 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: 30cdf15

Reviewed: 5 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.