CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

70

Quality

88%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

82%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, highly actionable skill body: the 10-step sequence, priority-ordered checklist, and copy-paste templates make it immediately executable. Weaknesses are minor — a few redundant sentences, no explicit validate-after-writing loop, and slightly inconsistent bundle navigation (broken template paths from references/, one orphaned template).

Suggestions

Add an explicit validation checkpoint after writing docs (e.g., 'Verify examples compile with go test ./... and preview with go doc') to close the workflow feedback loop.

Fix relative template links in references/ (./templates/... should be ../assets/templates/...) and link assets/templates/CONTRIBUTING.md from Step 5.

Trim restated-common-knowledge bullets (e.g., Step 9 'Clarity') and the overlap between Step 1 and Step 6 library scope.

DimensionReasoningScore

Conciseness

The body is largely lean: imperative principles, a priority-ordered checklist, and templates pushed to bundle files rather than inlined. A few tokens don't earn their place — e.g., Step 9's 'Clarity — a clear, well-structured documentation helps AI agents understand your project quickly' restates the obvious, and Step 6 bullets partially repeat Step 1's library scope. Efficient with minor trims possible, so 4 rather than 5.

4 / 5

Actionability

Guidance is copy-paste ready: a full doc-comment format example, exact README section order, a shields.io badge snippet, copy-paste delivery commands ('go get github.com/{owner}/{repo}', 'go install ... @latest', curl/docker one-liners), an API-style tool table, and concrete templates in assets/templates/ (README.md, CHANGELOG.md, llms.txt). Specific examples cover the common cases.

5 / 5

Workflow Clarity

Steps 1-10 form a clear, ordered sequence (detect project type → checklist → per-layer guidance), and review mode defines sub-agent splits. Checkpoints exist but are mostly implicit rather than explicit instructions — e.g., 'go doc' to preview and Example functions 'verified by go test' are mentioned as facts, not as validate-after-writing steps. Clear sequence with minor validation gaps fits 4; it does not reach 5 because there is no explicit write → verify → fix feedback loop.

4 / 5

Progressive Disclosure

SKILL.md is an overview with well-signaled, one-level-deep links to references/library.md, application.md, code-comments.md, project-docs.md and assets/templates/ — all of which exist. Two minor gaps: references/*.md link to './templates/...' which is broken relative to their location (templates live at assets/templates/), and assets/templates/CONTRIBUTING.md is never referenced from SKILL.md or Step 5. Good structure with minor organization gaps, hence 4 rather than 5.

4 / 5

Total

17

/

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 description: it names the domain, enumerates concrete deliverables, and provides an explicit 'Use when' clause covering both libraries and applications/CLIs. The only weakness is that some natural trigger terms (README, godoc, changelog) appear as covered artifacts rather than as phrases a user would say when invoking the skill.

Suggestions

Add natural trigger phrasing such as 'Use when the user mentions README, godoc, or changelog entries' to round out keyword coverage.

Consider mentioning 'missing or outdated docs' as a trigger scenario for review-mode invocations.

DimensionReasoningScore

Specificity

"covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt" plus "writing or reviewing doc comments, documentation, adding code examples, setting up doc sites" lists multiple specific concrete capabilities with comprehensive coverage of the Go documentation domain. It is not a 4 because coverage of both artifacts and actions is broad with no meaningful gaps.

5 / 5

Completeness

"Comprehensive documentation guide for Golang projects, covering..." explicitly answers what it does, and "Use when writing or reviewing doc comments, documentation, adding code examples, setting up doc sites, or discussing documentation best practices" gives an explicit when clause with concrete trigger phrases, matching the top anchor.

5 / 5

Trigger Term Quality

"writing or reviewing doc comments", "documentation", "adding code examples", "setting up doc sites", "applications/CLIs" are natural phrases a user would say. A few natural terms are missing (e.g., "README", "godoc", "changelog" are stated as covered artifacts but not as trigger phrases), so it falls just below the comprehensive-with-synonyms anchor of 5.

4 / 5

Distinctiveness Conflict Risk

The Go-specific vocabulary ("godoc comments", "Go Playground", "Example tests", "Golang projects") carves out a clear niche with distinct triggers and minimal overlap risk with generic writing or doc skills.

5 / 5

Total

19

/

20

Passed

Validation

87%

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

CriteriaDescriptionResult

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

Reviewed

Table of Contents

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.