[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M79AP5G93CPDEF5V98CTQSN4":3,"skill-same:01M79AP5G93CPDEF5V98CTQSN4":98},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":16,"categories":17,"keywords":18,"publishedAt":19,"linkOnly":20,"markdownContent":21,"markdownBody":22,"frontMatter":23,"refName":37,"commitSha":38,"skillDirectory":39,"forksCount":40,"repositoryHtmlUrl":41,"repositoryHomepageUrl":6,"ownerHtmlUrl":42,"ownerBlogUrl":43,"ownerDescription":6,"updatedAt":44,"install":45,"resources":57},"01M79AP5G93CPDEF5V98CTQSN4","golang-documentation",null,"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\u002FCLIs.","CCH-HQ\u002Fcchp-automation","CCH-HQ","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F253065381?v=4","01M79AG9QPRTJEVTCT1ZS7TM9J","CCH HQ","01M79AG9RNM4TAB3PJQH71X62P",2,"MIT","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002FSKILL.md",[],[],"2026-11-15 14:19:17",false,"---\nname: golang-documentation\ndescription: \"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\u002FCLIs.\"\nuser-invocable: true\nlicense: MIT\ncompatibility: Designed for Claude Code or similar AI coding agents, and for projects using Golang.\nmetadata:\n  author: samber\n  version: \"1.1.6\"\n  openclaw:\n    emoji: \"📝\"\n    homepage: https:\u002F\u002Fgithub.com\u002Fsamber\u002Fcc-skills-golang\n    requires:\n      bins:\n        - go\n    install: []\nallowed-tools: Read Edit Write Glob Grep Bash(go:*) Bash(golangci-lint:*) Bash(git:*) Agent WebFetch\n---\n\n**Persona:** You are a Go technical writer and API designer. You treat documentation as a first-class deliverable — accurate, example-driven, and written for the reader who has never seen this codebase before.\n\n**Orchestration mode:** Use `ultracode` for documenting or auditing documentation across a large codebase — orchestrate the sub-agents described in the \"Parallelizing Documentation Work\" section (one per package, or one per doc layer\u002Ffile) and merge their output into the final docs.\n\n**Modes:**\n\n- **Write mode** — generating or filling in missing documentation (doc comments, README, CONTRIBUTING, CHANGELOG, llms.txt). Work sequentially through the checklist in Step 2, or parallelize across packages\u002Ffiles using sub-agents.\n- **Review mode** — auditing existing documentation for completeness, accuracy, and style. Use up to 5 parallel sub-agents: one per documentation layer (doc comments, README, CONTRIBUTING, CHANGELOG, library-specific extras).\n\n> **Community default.** A company skill that explicitly supersedes `samber\u002Fcc-skills-golang@golang-documentation` skill takes precedence.\n\n# Go Documentation\n\nWrite documentation that serves both humans and AI agents. Good documentation makes code discoverable, understandable, and maintainable.\n\n## Cross-References\n\nSee `samber\u002Fcc-skills-golang@golang-naming` skill for naming conventions in doc comments. See `samber\u002Fcc-skills-golang@golang-testing` skill for Example test functions. See `samber\u002Fcc-skills-golang@golang-project-layout` skill for where documentation files belong.\n\n## Writing Principles\n\nApply to every piece of documentation you write or review:\n\n**Concision** — write the shortest version that carries the idea. Remove ornament and hollow transitions. Never drop facts, warnings, or user-requested depth.\n\n**Intent over paraphrase** — code shows _what_ happens; docs explain _why_ it exists, _when_ to use it, _what constraints_ apply. A comment that only restates the signature wastes the reader's time.\n\n**No invented context** — omit unsupported rationale, marketing claims (`seamlessly`, `robust`, `enterprise-grade`), or future promises. Leave gaps visible rather than filling with speculation.\n\n**Preserve meaning when editing** — keep modality intact (`must`\u002F`should`\u002F`may` are different obligations). Preserve conditions, warnings, required actions. A cleaner sentence that changes obligations is wrong.\n\n**Anti-patterns to remove on sight:** pure-paraphrase comments that start with the name but add nothing (godoc requires the name as prefix — what it forbids is stopping there), signature restatement, marketing vocabulary, groundless future claims (`future extensibility`, `easy to scale`), hollow transitions (`it's worth noting that`, `in conclusion`), template padding that adds no information.\n\n## Step 1: Detect Project Type\n\nBefore documenting, determine the project type — it changes what documentation is needed:\n\n**Library** — no `main` package, meant to be imported by other projects:\n\n- Focus on godoc comments, `ExampleXxx` functions, playground demos, pkg.go.dev rendering\n- See [Library Documentation](.\u002Freferences\u002Flibrary.md)\n\n**Application\u002FCLI** — has `main` package, `cmd\u002F` directory, produces a binary or Docker image:\n\n- Focus on installation instructions, CLI help text, configuration docs\n- See [Application Documentation](.\u002Freferences\u002Fapplication.md)\n\n**Both apply**: function comments, README, CONTRIBUTING, CHANGELOG.\n\n**Architecture docs**: for complex projects, use the `docs\u002F` directory and design description docs.\n\n## Step 2: Documentation Checklist\n\nEvery Go project needs these (ordered by priority):\n\n| Item | Required | Library | Application |\n| --- | --- | --- | --- |\n| Doc comments on exported functions | Yes | Yes | Yes |\n| Package comment (`\u002F\u002F Package foo...`) — MUST exist | Yes | Yes | Yes |\n| README.md | Yes | Yes | Yes |\n| LICENSE | Yes | Yes | Yes |\n| Getting started \u002F installation | Yes | Yes | Yes |\n| Working code examples | Yes | Yes | Yes |\n| CONTRIBUTING.md | Recommended | Yes | Yes |\n| CHANGELOG.md or GitHub Releases | Recommended | Yes | Yes |\n| Example test functions (`ExampleXxx`) | Recommended | Yes | No |\n| Go Playground demos | Recommended | Yes | No |\n| API docs (e.g., OpenAPI) | If applicable | Maybe | Maybe |\n| Documentation website | Large projects | Maybe | Maybe |\n| llms.txt | Recommended | Yes | Yes |\n\nA private project might not need a documentation website, llms.txt, Go Playground demos...\n\n## Parallelizing Documentation Work\n\nWhen documenting a large codebase with many packages, use up to 5 parallel sub-agents (via the Agent tool) for independent tasks:\n\n- Assign each sub-agent to verify and fix doc comments in a different set of packages\n- Generate `ExampleXxx` test functions for multiple packages simultaneously\n- Generate project docs in parallel: one sub-agent per file (README, CONTRIBUTING, CHANGELOG, llms.txt)\n\n## Step 3: Function & Method Doc Comments\n\nEvery exported function and method MUST have a doc comment. Document complex internal functions too. Skip test functions.\n\nThe comment starts with the function name and a verb phrase. Focus on **why** and **when**, not restating what the code already shows. The code tells you _what_ happens — the comment should explain _why_ it exists, _when_ to use it, _what constraints_ apply, and _what can go wrong_. Include parameters, return values, error cases, and a usage example:\n\n```go\n\u002F\u002F CalculateDiscount computes the final price after applying tiered discounts.\n\u002F\u002F Discounts are applied progressively based on order quantity: each tier unlocks\n\u002F\u002F additional percentage reduction. Returns an error if the quantity is invalid or\n\u002F\u002F if the base price would result in a negative value after discount application.\n\u002F\u002F\n\u002F\u002F Parameters:\n\u002F\u002F   - basePrice: The original price before any discounts (must be non-negative)\n\u002F\u002F   - quantity: The number of units ordered (must be positive)\n\u002F\u002F   - tiers: A slice of discount tiers sorted by minimum quantity threshold\n\u002F\u002F\n\u002F\u002F Returns the final discounted price rounded to 2 decimal places.\n\u002F\u002F Returns ErrInvalidPrice if basePrice is negative.\n\u002F\u002F Returns ErrInvalidQuantity if quantity is zero or negative.\n\u002F\u002F\n\u002F\u002F Play: https:\u002F\u002Fgo.dev\u002Fplay\u002Fp\u002Fabc123XYZ\n\u002F\u002F\n\u002F\u002F Example:\n\u002F\u002F\n\u002F\u002F\ttiers := []DiscountTier{\n\u002F\u002F\t    {MinQuantity: 10, PercentOff: 5},\n\u002F\u002F\t    {MinQuantity: 50, PercentOff: 15},\n\u002F\u002F\t    {MinQuantity: 100, PercentOff: 25},\n\u002F\u002F\t}\n\u002F\u002F\tfinalPrice, err := CalculateDiscount(100.00, 75, tiers)\n\u002F\u002F\tif err != nil {\n\u002F\u002F\t    log.Fatalf(\"Discount calculation failed: %v\", err)\n\u002F\u002F\t}\n\u002F\u002F\tlog.Printf(\"Ordered 75 units at $100 each: final price = $%.2f\", finalPrice)\nfunc CalculateDiscount(basePrice float64, quantity int, tiers []DiscountTier) (float64, error) {\n    \u002F\u002F implementation\n}\n```\n\nFor the full comment format, deprecated markers, interface docs, and file-level comments, see **[Code Comments](.\u002Freferences\u002Fcode-comments.md)** — how to document packages, functions, interfaces, and when to use `Deprecated:` markers and `BUG:` notes.\n\n## Step 4: README Structure\n\nREADME SHOULD follow this exact section order. Copy the template from [templates\u002FREADME.md](.\u002Fassets\u002Ftemplates\u002FREADME.md):\n\n1. **Title** — project name as `# heading`\n2. **Badges** — shields.io pictograms (Go version, license, CI, coverage, Go Report Card...)\n3. **Summary** — 1-2 sentences explaining what the project does\n4. **Demo** — code snippet, GIF, screenshot, or video showing the project in action\n5. **Getting Started** — installation + minimal working example\n6. **Features \u002F Specification** — detailed feature list or specification (very long section)\n7. **Contributing** — link to CONTRIBUTING.md or inline if very short\n8. **Contributors** — thank contributors (badge or list)\n9. **License** — license name + link\n\nCommon badges for Go projects:\n\n```markdown\n[![Go Version](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fgo-mod\u002Fgo-version\u002F{owner}\u002F{repo})](https:\u002F\u002Fgo.dev\u002F) [![License](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002F{owner}\u002F{repo})](.\u002FLICENSE) [![Build Status](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Factions\u002Fworkflow\u002Fstatus\u002F{owner}\u002F{repo}\u002Ftest.yml?branch=main)](https:\u002F\u002Fgithub.com\u002F{owner}\u002F{repo}\u002Factions) [![Coverage](https:\u002F\u002Fimg.shields.io\u002Fcodecov\u002Fc\u002Fgithub\u002F{owner}\u002F{repo})](https:\u002F\u002Fcodecov.io\u002Fgh\u002F{owner}\u002F{repo}) [![Go Report Card](https:\u002F\u002Fgoreportcard.com\u002Fbadge\u002Fgithub.com\u002F{owner}\u002F{repo})](https:\u002F\u002Fgoreportcard.com\u002Freport\u002Fgithub.com\u002F{owner}\u002F{repo}) [![Go Reference](https:\u002F\u002Fpkg.go.dev\u002Fbadge\u002Fgithub.com\u002F{owner}\u002F{repo}.svg)](https:\u002F\u002Fpkg.go.dev\u002Fgithub.com\u002F{owner}\u002F{repo})\n```\n\nFor the full README guidance and application-specific sections, see [Project Docs](.\u002Freferences\u002Fproject-docs.md#readme).\n\n## Step 5: CONTRIBUTING & Changelog\n\n**CONTRIBUTING.md** — Help contributors get started in under 10 minutes. Include: prerequisites, clone, build, test, PR process. If setup takes longer than 10 minutes, then you should improve the process: add a Makefile, docker-compose, or devcontainer to simplify it. See [Project Docs](.\u002Freferences\u002Fproject-docs.md#contributingmd).\n\n**Changelog** — Track changes using [Keep a Changelog](https:\u002F\u002Fkeepachangelog.com\u002F) format or GitHub Releases. Copy the template from [templates\u002FCHANGELOG.md](.\u002Fassets\u002Ftemplates\u002FCHANGELOG.md). Each entry answers _what changed for the reader_ — internal refactors without user-visible impact belong in commit history. Don't inflate a fixed edge case into a broad \"reliability improvement\" claim. See [Project Docs](.\u002Freferences\u002Fproject-docs.md#changelog).\n\n## Step 6: Library-Specific Documentation\n\nFor Go libraries, add these on top of the basics:\n\n- **Go Playground demos** — create runnable demos and link them in doc comments with `\u002F\u002F Play: https:\u002F\u002Fgo.dev\u002Fplay\u002Fp\u002Fxxx`. Use the go-playground MCP tool when available to create and share playground URLs.\n- **Example test functions** — write `func ExampleXxx()` in `_test.go` files. These are executable documentation verified by `go test`.\n- **Generous code examples** — include multiple examples in doc comments showing common use cases.\n- **godoc** — your doc comments render on [pkg.go.dev](https:\u002F\u002Fpkg.go.dev). Use `go doc` locally to preview; to inspect how a published package renders its docs, symbols, and examples, → See `samber\u002Fcc-skills-golang@golang-pkg-go-dev` skill.\n- **Documentation website** — for large libraries, consider Docusaurus or MkDocs Material with sections: Getting Started, Tutorial, How-to Guides, Reference, Explanation.\n- **Register for discoverability** — add to Context7, DeepWiki, OpenDeep, zRead. Even for private libraries.\n\nSee [Library Documentation](.\u002Freferences\u002Flibrary.md) for details.\n\n## Step 7: Application-Specific Documentation\n\nFor Go applications\u002FCLIs:\n\n- **Installation methods** — pre-built binaries (GoReleaser), `go install`, Docker images, Homebrew...\n- **CLI help text** — make `--help` comprehensive; it's the primary documentation\n- **Configuration docs** — document all env vars, config files, CLI flags\n\nSee [Application Documentation](.\u002Freferences\u002Fapplication.md) for details.\n\n## Step 8: API Documentation\n\nIf your project exposes an API:\n\n| API Style    | Format      | Tool                                         |\n| ------------ | ----------- | -------------------------------------------- |\n| REST\u002FHTTP    | OpenAPI 3.x | swaggo\u002Fswag (auto-generate from annotations) |\n| Event-driven | AsyncAPI    | Manual or code-gen                           |\n| gRPC         | Protobuf    | buf, grpc-gateway                            |\n\nPrefer auto-generation from code annotations when possible. See [Application Documentation](.\u002Freferences\u002Fapplication.md#api-documentation) for details.\n\n## Step 9: AI-Friendly Documentation\n\nMake your project consumable by AI agents:\n\n- **llms.txt** — add a `llms.txt` file at the repository root. Copy the template from [templates\u002Fllms.txt](.\u002Fassets\u002Ftemplates\u002Fllms.txt). This file gives LLMs a structured overview of your project.\n- **Structured formats** — use OpenAPI, AsyncAPI, or protobuf for machine-readable API docs.\n- **Consistent doc comments** — well-structured godoc comments are easily parsed by AI tools.\n- **Clarity** — a clear, well-structured documentation helps AI agents understand your project quickly.\n\n## Step 10: Delivery Documentation\n\nDocument how users get your project:\n\n**Libraries:**\n\n```bash\ngo get github.com\u002F{owner}\u002F{repo}\n```\n\n**Applications:**\n\n```bash\n# Pre-built binary\ncurl -sSL https:\u002F\u002Fgithub.com\u002F{owner}\u002F{repo}\u002Freleases\u002Flatest\u002Fdownload\u002F{repo}-$(uname -s)-$(uname -m) -o \u002Fusr\u002Flocal\u002Fbin\u002F{repo}\n\n# From source\ngo install github.com\u002F{owner}\u002F{repo}@latest\n\n# Docker\ndocker pull {registry}\u002F{owner}\u002F{repo}:latest\n```\n\nSee [Project Docs](.\u002Freferences\u002Fproject-docs.md#delivery) for Dockerfile best practices and Homebrew tap setup.\n","**Persona:** You are a Go technical writer and API designer. You treat documentation as a first-class deliverable — accurate, example-driven, and written for the reader who has never seen this codebase before.\n\n**Orchestration mode:** Use `ultracode` for documenting or auditing documentation across a large codebase — orchestrate the sub-agents described in the \"Parallelizing Documentation Work\" section (one per package, or one per doc layer\u002Ffile) and merge their output into the final docs.\n\n**Modes:**\n\n- **Write mode** — generating or filling in missing documentation (doc comments, README, CONTRIBUTING, CHANGELOG, llms.txt). Work sequentially through the checklist in Step 2, or parallelize across packages\u002Ffiles using sub-agents.\n- **Review mode** — auditing existing documentation for completeness, accuracy, and style. Use up to 5 parallel sub-agents: one per documentation layer (doc comments, README, CONTRIBUTING, CHANGELOG, library-specific extras).\n\n> **Community default.** A company skill that explicitly supersedes `samber\u002Fcc-skills-golang@golang-documentation` skill takes precedence.\n\n# Go Documentation\n\nWrite documentation that serves both humans and AI agents. Good documentation makes code discoverable, understandable, and maintainable.\n\n## Cross-References\n\nSee `samber\u002Fcc-skills-golang@golang-naming` skill for naming conventions in doc comments. See `samber\u002Fcc-skills-golang@golang-testing` skill for Example test functions. See `samber\u002Fcc-skills-golang@golang-project-layout` skill for where documentation files belong.\n\n## Writing Principles\n\nApply to every piece of documentation you write or review:\n\n**Concision** — write the shortest version that carries the idea. Remove ornament and hollow transitions. Never drop facts, warnings, or user-requested depth.\n\n**Intent over paraphrase** — code shows _what_ happens; docs explain _why_ it exists, _when_ to use it, _what constraints_ apply. A comment that only restates the signature wastes the reader's time.\n\n**No invented context** — omit unsupported rationale, marketing claims (`seamlessly`, `robust`, `enterprise-grade`), or future promises. Leave gaps visible rather than filling with speculation.\n\n**Preserve meaning when editing** — keep modality intact (`must`\u002F`should`\u002F`may` are different obligations). Preserve conditions, warnings, required actions. A cleaner sentence that changes obligations is wrong.\n\n**Anti-patterns to remove on sight:** pure-paraphrase comments that start with the name but add nothing (godoc requires the name as prefix — what it forbids is stopping there), signature restatement, marketing vocabulary, groundless future claims (`future extensibility`, `easy to scale`), hollow transitions (`it's worth noting that`, `in conclusion`), template padding that adds no information.\n\n## Step 1: Detect Project Type\n\nBefore documenting, determine the project type — it changes what documentation is needed:\n\n**Library** — no `main` package, meant to be imported by other projects:\n\n- Focus on godoc comments, `ExampleXxx` functions, playground demos, pkg.go.dev rendering\n- See [Library Documentation](.\u002Freferences\u002Flibrary.md)\n\n**Application\u002FCLI** — has `main` package, `cmd\u002F` directory, produces a binary or Docker image:\n\n- Focus on installation instructions, CLI help text, configuration docs\n- See [Application Documentation](.\u002Freferences\u002Fapplication.md)\n\n**Both apply**: function comments, README, CONTRIBUTING, CHANGELOG.\n\n**Architecture docs**: for complex projects, use the `docs\u002F` directory and design description docs.\n\n## Step 2: Documentation Checklist\n\nEvery Go project needs these (ordered by priority):\n\n| Item | Required | Library | Application |\n| --- | --- | --- | --- |\n| Doc comments on exported functions | Yes | Yes | Yes |\n| Package comment (`\u002F\u002F Package foo...`) — MUST exist | Yes | Yes | Yes |\n| README.md | Yes | Yes | Yes |\n| LICENSE | Yes | Yes | Yes |\n| Getting started \u002F installation | Yes | Yes | Yes |\n| Working code examples | Yes | Yes | Yes |\n| CONTRIBUTING.md | Recommended | Yes | Yes |\n| CHANGELOG.md or GitHub Releases | Recommended | Yes | Yes |\n| Example test functions (`ExampleXxx`) | Recommended | Yes | No |\n| Go Playground demos | Recommended | Yes | No |\n| API docs (e.g., OpenAPI) | If applicable | Maybe | Maybe |\n| Documentation website | Large projects | Maybe | Maybe |\n| llms.txt | Recommended | Yes | Yes |\n\nA private project might not need a documentation website, llms.txt, Go Playground demos...\n\n## Parallelizing Documentation Work\n\nWhen documenting a large codebase with many packages, use up to 5 parallel sub-agents (via the Agent tool) for independent tasks:\n\n- Assign each sub-agent to verify and fix doc comments in a different set of packages\n- Generate `ExampleXxx` test functions for multiple packages simultaneously\n- Generate project docs in parallel: one sub-agent per file (README, CONTRIBUTING, CHANGELOG, llms.txt)\n\n## Step 3: Function & Method Doc Comments\n\nEvery exported function and method MUST have a doc comment. Document complex internal functions too. Skip test functions.\n\nThe comment starts with the function name and a verb phrase. Focus on **why** and **when**, not restating what the code already shows. The code tells you _what_ happens — the comment should explain _why_ it exists, _when_ to use it, _what constraints_ apply, and _what can go wrong_. Include parameters, return values, error cases, and a usage example:\n\n```go\n\u002F\u002F CalculateDiscount computes the final price after applying tiered discounts.\n\u002F\u002F Discounts are applied progressively based on order quantity: each tier unlocks\n\u002F\u002F additional percentage reduction. Returns an error if the quantity is invalid or\n\u002F\u002F if the base price would result in a negative value after discount application.\n\u002F\u002F\n\u002F\u002F Parameters:\n\u002F\u002F   - basePrice: The original price before any discounts (must be non-negative)\n\u002F\u002F   - quantity: The number of units ordered (must be positive)\n\u002F\u002F   - tiers: A slice of discount tiers sorted by minimum quantity threshold\n\u002F\u002F\n\u002F\u002F Returns the final discounted price rounded to 2 decimal places.\n\u002F\u002F Returns ErrInvalidPrice if basePrice is negative.\n\u002F\u002F Returns ErrInvalidQuantity if quantity is zero or negative.\n\u002F\u002F\n\u002F\u002F Play: https:\u002F\u002Fgo.dev\u002Fplay\u002Fp\u002Fabc123XYZ\n\u002F\u002F\n\u002F\u002F Example:\n\u002F\u002F\n\u002F\u002F\ttiers := []DiscountTier{\n\u002F\u002F\t    {MinQuantity: 10, PercentOff: 5},\n\u002F\u002F\t    {MinQuantity: 50, PercentOff: 15},\n\u002F\u002F\t    {MinQuantity: 100, PercentOff: 25},\n\u002F\u002F\t}\n\u002F\u002F\tfinalPrice, err := CalculateDiscount(100.00, 75, tiers)\n\u002F\u002F\tif err != nil {\n\u002F\u002F\t    log.Fatalf(\"Discount calculation failed: %v\", err)\n\u002F\u002F\t}\n\u002F\u002F\tlog.Printf(\"Ordered 75 units at $100 each: final price = $%.2f\", finalPrice)\nfunc CalculateDiscount(basePrice float64, quantity int, tiers []DiscountTier) (float64, error) {\n    \u002F\u002F implementation\n}\n```\n\nFor the full comment format, deprecated markers, interface docs, and file-level comments, see **[Code Comments](.\u002Freferences\u002Fcode-comments.md)** — how to document packages, functions, interfaces, and when to use `Deprecated:` markers and `BUG:` notes.\n\n## Step 4: README Structure\n\nREADME SHOULD follow this exact section order. Copy the template from [templates\u002FREADME.md](.\u002Fassets\u002Ftemplates\u002FREADME.md):\n\n1. **Title** — project name as `# heading`\n2. **Badges** — shields.io pictograms (Go version, license, CI, coverage, Go Report Card...)\n3. **Summary** — 1-2 sentences explaining what the project does\n4. **Demo** — code snippet, GIF, screenshot, or video showing the project in action\n5. **Getting Started** — installation + minimal working example\n6. **Features \u002F Specification** — detailed feature list or specification (very long section)\n7. **Contributing** — link to CONTRIBUTING.md or inline if very short\n8. **Contributors** — thank contributors (badge or list)\n9. **License** — license name + link\n\nCommon badges for Go projects:\n\n```markdown\n[![Go Version](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fgo-mod\u002Fgo-version\u002F{owner}\u002F{repo})](https:\u002F\u002Fgo.dev\u002F) [![License](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002F{owner}\u002F{repo})](.\u002FLICENSE) [![Build Status](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Factions\u002Fworkflow\u002Fstatus\u002F{owner}\u002F{repo}\u002Ftest.yml?branch=main)](https:\u002F\u002Fgithub.com\u002F{owner}\u002F{repo}\u002Factions) [![Coverage](https:\u002F\u002Fimg.shields.io\u002Fcodecov\u002Fc\u002Fgithub\u002F{owner}\u002F{repo})](https:\u002F\u002Fcodecov.io\u002Fgh\u002F{owner}\u002F{repo}) [![Go Report Card](https:\u002F\u002Fgoreportcard.com\u002Fbadge\u002Fgithub.com\u002F{owner}\u002F{repo})](https:\u002F\u002Fgoreportcard.com\u002Freport\u002Fgithub.com\u002F{owner}\u002F{repo}) [![Go Reference](https:\u002F\u002Fpkg.go.dev\u002Fbadge\u002Fgithub.com\u002F{owner}\u002F{repo}.svg)](https:\u002F\u002Fpkg.go.dev\u002Fgithub.com\u002F{owner}\u002F{repo})\n```\n\nFor the full README guidance and application-specific sections, see [Project Docs](.\u002Freferences\u002Fproject-docs.md#readme).\n\n## Step 5: CONTRIBUTING & Changelog\n\n**CONTRIBUTING.md** — Help contributors get started in under 10 minutes. Include: prerequisites, clone, build, test, PR process. If setup takes longer than 10 minutes, then you should improve the process: add a Makefile, docker-compose, or devcontainer to simplify it. See [Project Docs](.\u002Freferences\u002Fproject-docs.md#contributingmd).\n\n**Changelog** — Track changes using [Keep a Changelog](https:\u002F\u002Fkeepachangelog.com\u002F) format or GitHub Releases. Copy the template from [templates\u002FCHANGELOG.md](.\u002Fassets\u002Ftemplates\u002FCHANGELOG.md). Each entry answers _what changed for the reader_ — internal refactors without user-visible impact belong in commit history. Don't inflate a fixed edge case into a broad \"reliability improvement\" claim. See [Project Docs](.\u002Freferences\u002Fproject-docs.md#changelog).\n\n## Step 6: Library-Specific Documentation\n\nFor Go libraries, add these on top of the basics:\n\n- **Go Playground demos** — create runnable demos and link them in doc comments with `\u002F\u002F Play: https:\u002F\u002Fgo.dev\u002Fplay\u002Fp\u002Fxxx`. Use the go-playground MCP tool when available to create and share playground URLs.\n- **Example test functions** — write `func ExampleXxx()` in `_test.go` files. These are executable documentation verified by `go test`.\n- **Generous code examples** — include multiple examples in doc comments showing common use cases.\n- **godoc** — your doc comments render on [pkg.go.dev](https:\u002F\u002Fpkg.go.dev). Use `go doc` locally to preview; to inspect how a published package renders its docs, symbols, and examples, → See `samber\u002Fcc-skills-golang@golang-pkg-go-dev` skill.\n- **Documentation website** — for large libraries, consider Docusaurus or MkDocs Material with sections: Getting Started, Tutorial, How-to Guides, Reference, Explanation.\n- **Register for discoverability** — add to Context7, DeepWiki, OpenDeep, zRead. Even for private libraries.\n\nSee [Library Documentation](.\u002Freferences\u002Flibrary.md) for details.\n\n## Step 7: Application-Specific Documentation\n\nFor Go applications\u002FCLIs:\n\n- **Installation methods** — pre-built binaries (GoReleaser), `go install`, Docker images, Homebrew...\n- **CLI help text** — make `--help` comprehensive; it's the primary documentation\n- **Configuration docs** — document all env vars, config files, CLI flags\n\nSee [Application Documentation](.\u002Freferences\u002Fapplication.md) for details.\n\n## Step 8: API Documentation\n\nIf your project exposes an API:\n\n| API Style    | Format      | Tool                                         |\n| ------------ | ----------- | -------------------------------------------- |\n| REST\u002FHTTP    | OpenAPI 3.x | swaggo\u002Fswag (auto-generate from annotations) |\n| Event-driven | AsyncAPI    | Manual or code-gen                           |\n| gRPC         | Protobuf    | buf, grpc-gateway                            |\n\nPrefer auto-generation from code annotations when possible. See [Application Documentation](.\u002Freferences\u002Fapplication.md#api-documentation) for details.\n\n## Step 9: AI-Friendly Documentation\n\nMake your project consumable by AI agents:\n\n- **llms.txt** — add a `llms.txt` file at the repository root. Copy the template from [templates\u002Fllms.txt](.\u002Fassets\u002Ftemplates\u002Fllms.txt). This file gives LLMs a structured overview of your project.\n- **Structured formats** — use OpenAPI, AsyncAPI, or protobuf for machine-readable API docs.\n- **Consistent doc comments** — well-structured godoc comments are easily parsed by AI tools.\n- **Clarity** — a clear, well-structured documentation helps AI agents understand your project quickly.\n\n## Step 10: Delivery Documentation\n\nDocument how users get your project:\n\n**Libraries:**\n\n```bash\ngo get github.com\u002F{owner}\u002F{repo}\n```\n\n**Applications:**\n\n```bash\n# Pre-built binary\ncurl -sSL https:\u002F\u002Fgithub.com\u002F{owner}\u002F{repo}\u002Freleases\u002Flatest\u002Fdownload\u002F{repo}-$(uname -s)-$(uname -m) -o \u002Fusr\u002Flocal\u002Fbin\u002F{repo}\n\n# From source\ngo install github.com\u002F{owner}\u002F{repo}@latest\n\n# Docker\ndocker pull {registry}\u002F{owner}\u002F{repo}:latest\n```\n\nSee [Project Docs](.\u002Freferences\u002Fproject-docs.md#delivery) for Dockerfile best practices and Homebrew tap setup.\n",{"name":5,"license":15,"metadata":24,"description":7,"allowed-tools":34,"compatibility":35,"user-invocable":36},{"author":25,"version":26,"openclaw":27},"samber","1.1.6",{"emoji":28,"install":29,"homepage":30,"requires":31},"📝",[],"https:\u002F\u002Fgithub.com\u002Fsamber\u002Fcc-skills-golang",{"bins":32},[33],"go","Read Edit Write Glob Grep Bash(go:*) Bash(golangci-lint:*) Bash(git:*) Agent WebFetch","Designed for Claude Code or similar AI coding agents, and for projects using Golang.",true,"main","a93764baed707eda5a68d91e19e5719368e6335e","skills-backup\u002Fskills\u002Fgolang-documentation",0,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation","https:\u002F\u002Fgithub.com\u002FCCH-HQ","https:\u002F\u002Fclaude-code-hub.app\u002F","2026-11-09 20:50:54",{"source":8,"skillName":5,"commands":46,"prompt":56,"zipAvailable":36},[47,50,53],{"tool":48,"command":49},"npx","npx skills add CCH-HQ\u002Fcchp-automation --skill golang-documentation",{"tool":51,"command":52},"bunx","bunx skills add CCH-HQ\u002Fcchp-automation --skill golang-documentation",{"tool":54,"command":55},"pnpm","pnpm dlx skills add CCH-HQ\u002Fcchp-automation --skill golang-documentation","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002FSKILL.md",[58,64,68,72,76,82,86,90,94],{"path":59,"resourceType":60,"resourceTypeDesc":61,"sizeBytes":62,"sourceHtmlUrl":63},"assets\u002Ftemplates\u002FCHANGELOG.md","ASSET","资产文件",675,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Fassets\u002Ftemplates\u002FCHANGELOG.md",{"path":65,"resourceType":60,"resourceTypeDesc":61,"sizeBytes":66,"sourceHtmlUrl":67},"assets\u002Ftemplates\u002FCONTRIBUTING.md",1163,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Fassets\u002Ftemplates\u002FCONTRIBUTING.md",{"path":69,"resourceType":60,"resourceTypeDesc":61,"sizeBytes":70,"sourceHtmlUrl":71},"assets\u002Ftemplates\u002Fllms.txt",1236,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Fassets\u002Ftemplates\u002Fllms.txt",{"path":73,"resourceType":60,"resourceTypeDesc":61,"sizeBytes":74,"sourceHtmlUrl":75},"assets\u002Ftemplates\u002FREADME.md",3872,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Fassets\u002Ftemplates\u002FREADME.md",{"path":77,"resourceType":78,"resourceTypeDesc":79,"sizeBytes":80,"sourceHtmlUrl":81},"evals\u002Fevals.json","REFERENCE","参考文档",29068,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Fevals\u002Fevals.json",{"path":83,"resourceType":78,"resourceTypeDesc":79,"sizeBytes":84,"sourceHtmlUrl":85},"references\u002Fapplication.md",5505,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Freferences\u002Fapplication.md",{"path":87,"resourceType":78,"resourceTypeDesc":79,"sizeBytes":88,"sourceHtmlUrl":89},"references\u002Fcode-comments.md",11372,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Freferences\u002Fcode-comments.md",{"path":91,"resourceType":78,"resourceTypeDesc":79,"sizeBytes":92,"sourceHtmlUrl":93},"references\u002Flibrary.md",6898,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Freferences\u002Flibrary.md",{"path":95,"resourceType":78,"resourceTypeDesc":79,"sizeBytes":96,"sourceHtmlUrl":97},"references\u002Fproject-docs.md",3975,"https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fgolang-documentation\u002Freferences\u002Fproject-docs.md",[99,106,113,120,127,134],{"skillNo":100,"name":101,"nameZh":6,"description":102,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":103,"categories":104,"keywords":105,"publishedAt":19},"01M79B44RKSB6Z0GENGYFCCZYA","writing-skills","Use when creating new skills, editing existing skills, or verifying skills work before deployment","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fwriting-skills\u002FSKILL.md",[],[],{"skillNo":107,"name":108,"nameZh":6,"description":109,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":110,"categories":111,"keywords":112,"publishedAt":19},"01M79B410BHDSNHZ7MKAYXWJHS","writing-plans","Use when you have a spec or requirements for a multi-step task, before touching code","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fwriting-plans\u002FSKILL.md",[],[],{"skillNo":114,"name":115,"nameZh":6,"description":116,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":117,"categories":118,"keywords":119,"publishedAt":19},"01M79B3XK29MCD5HGD50YGYXQZ","wizard","Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fwizard\u002FSKILL.md",[],[],{"skillNo":121,"name":122,"nameZh":6,"description":123,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":124,"categories":125,"keywords":126,"publishedAt":19},"01M79B3TFQEXXM2KK5V44H64DV","wayfinder","Plan a huge chunk of work — more than one agent session can hold — as a shared map of decision tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear.","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fwayfinder\u002FSKILL.md",[],[],{"skillNo":128,"name":129,"nameZh":6,"description":130,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":131,"categories":132,"keywords":133,"publishedAt":19},"01M79B3Q3WTMJDM6NNGG1X4NYK","verification-before-completion","Use when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fverification-before-completion\u002FSKILL.md",[],[],{"skillNo":135,"name":136,"nameZh":6,"description":137,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":138,"categories":139,"keywords":140,"publishedAt":19},"01M79B3GW8YCKT7W489HKWFMNC","vercel-react-best-practices","React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React\u002FNext.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.","https:\u002F\u002Fgithub.com\u002FCCH-HQ\u002Fcchp-automation\u002Fblob\u002Fmain\u002Fskills-backup\u002Fskills\u002Fvercel-react-best-practices\u002FSKILL.md",[],[]]