Write idiomatic godoc comments, READMEs, and example tests for Go packages.
npx skills add https://github.com/Qunnnn/agents --skill go-documentation-qunnnn
Please help me install this Agent Skill. Skill: go-documentation Source: https://github.com/Qunnnn/agents/tree/main/skills/go/go-documentation Command: npx skills add https://github.com/Qunnnn/agents --skill go-documentation-qunnnn
This Skill helps Go developers create consistent, discoverable documentation that improves API usability, project onboarding, and AI-assisted understanding.
Use the go-documentation skill to review my Go package and improve its documentation comments, README structure, and examples.
High-intent search queries and answers about installing and using this skill.
To write idiomatic godoc comments, begin the comment with the name of the exported package, type, or function. This Skill helps apply consistent documentation practices to exported identifiers, ensuring your Go API is discoverable and easy to onboard.
The best way to structure a Golang README is to include clear project summaries, contributor guidance, and AI-friendly documentation files. This Skill helps organize your repository documentation to improve project onboarding and AI-assisted understanding.
To create runnable Example tests, you write test functions prefixed with Example in your Go test files. This Skill provides guidance for creating reliable, runnable examples that appear directly in your generated godoc documentation.
AI-friendly documentation improves Golang project onboarding by providing structured, consistent context that AI assistants can easily parse. This Skill helps generate project summaries and README structures optimized for AI-assisted understanding.
Yes, you can use this Skill to review your existing Go package and improve its documentation comments, README structure, and example tests. It applies idiomatic documentation practices to ensure consistency across your repository.
You need to update godoc comments whenever you modify exported types, functions, or variables in a Golang repository. This Skill ensures your documentation remains consistent and discoverable by applying idiomatic practices for exported identifiers.
kis9aGenerate and update Go documentation from source code.
omarluqGenerate Go project documentation with godoc comments, README templates, and llms.txt.
hellopoisonxWrite and review Go documentation with godoc conventions and structured checklists.
zero-rehqGenerate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.
