Standardize Go doc comments, package docs, and godoc formatting.
npx skills add https://github.com/cxuu/golang-skills --skill go-documentation
Please help me install this Agent Skill. Skill: go-documentation Source: https://github.com/cxuu/golang-skills/tree/main/skills/go-documentation Command: npx skills add https://github.com/cxuu/golang-skills --skill go-documentation
Documentation quality for Go code is often inconsistent across projects. This skill provides comprehensive guidelines for writing clear, consistent doc comments, package docs, and godoc formatting to improve readability and maintainability.
Apply these Go documentation guidelines when writing or reviewing Go packages, types, or functions.
High-intent search queries and answers about installing and using this skill.
Idiomatic Go documentation begins doc comments with the exported name and uses complete sentences. This skill enforces normative capitalization and sentence structure rules for Go packages, types, and functions to ensure consistency.
Correct godoc formatting places package comments directly above the package clause using standard conventions. This skill provides structured guidelines for godoc formatting and package docs to improve code readability and maintainability.
Runnable examples are added by writing functions named Example in your test files. This skill guides proper godoc formatting and example practices to demonstrate package usage and improve overall documentation quality.
Standardize Go code reviews by applying structured guidelines for doc comments and godoc formatting. This skill ensures new contributors follow a single standard when documenting Go code across codebases during onboarding and review.
You do not need external dependencies to enforce Go doc comment rules. This skill provides built-in structured guidelines for normative doc-comment rules and godoc formatting without requiring any additional components.
Go documentation appears inconsistent when exported names lack normative doc comments and standard godoc formatting. This skill solves inconsistent documentation by enforcing structured guidelines for package docs, types, and functions.
diegusclAnalyze Go module test coverage and suggest missing test cases.
kis9aGenerate and update Go documentation from source code.
hb9397Analyze staged Git changes for security risks and formatting violations.
dieu-donneeGenerate, format, and validate developer documentation from code comments and API specs.
