yechua-silva/zyrocli/golang-documentation

Claude Code and agent skill by yechua-silva/zyrocli

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

Go documentation best practices — doc comments, README, CONTRIBUTING, CHANGELOG, llms.txt

Install

npx vskill@latest install yechua-silva/zyrocli/golang-documentation

SKILL.md

The same SKILL.md was published earlier as yechua-silva/zyrocli/golang-documentation.

Go Documentation

Overview

Write and review Go documentation following Go's own conventions and best practices.

When to use

  • When writing doc comments for Go packages, types, functions, and methods
  • When creating or updating README.md, CONTRIBUTING.md, CHANGELOG.md
  • When reviewing documentation for correctness and completeness

Conventions

  • Doc comments: Follow Go's go doc conventions. First sentence is a complete summary.

``go // Package math provides basic constants and mathematical functions. package math ``

  • Exported identifiers: Always documented. Unexported: only if non-obvious.
  • README: What, why, how to use, how to contribute.
  • CHANGELOG: Keep a changelog following https://keepachangelog.com/
  • Code examples: Use runnable Example functions in _test.go files.
  • llms.txt: Provide structured context for LLMs reading the project.

Security

  • Security scanPassed, 90 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

Repository stars
1
7-day trend score
0

Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/yechua-silva/zyrocli/golang-documentation/badge)](https://verified-skill.com/skills/yechua-silva/zyrocli/golang-documentation)

Something wrong with this skill or its page? Tell us.