技能简介

samber/golang-documentation 是由知名 Go 开源作者 samber 维护的高质量文档撰写 Skill，质量评分 83（gold 等级），已通过 Skillstore 完整审计（2026-09-06）。它把 Go 社区长期沉淀的注释、Example、README、CONTRIBUTING、CHANGELOG 与 llms.txt 写作规范封装成可重复调用的提示模板，让 Claude、Codex、Claude Code 在生成 Go 项目文档时自动遵循官方约定，避免"复制粘贴式注释"和缺少示例的 API 说明。无论是发布新库、内部应用还是 CLI 工具，都能借助该 Skill 输出一致、可审、可运行示例的整套项目文档。

核心能力

按 Go 官方约定起草 package、type、function、method 的注释，确保 godoc 渲染后结构清晰、要点完整。
自动产出 README、CONTRIBUTING、CHANGELOG、llms.txt 等仓库级文档，章节切分与项目实际使用一致。
设计可运行的 ExampleXxx 测试函数与 Go Playground 文档链接，让示例真正可执行而非伪代码。
针对库、应用、命令行工具三类产物分别给出适配策略，输出贴合使用场景的差异化内容。
对既有文档做完整性、可信度、结构一致性审查，定位缺失上下文、不准确表述与薄弱章节。
给出明确"不发明 API、不堆砌泛注释、不直接搬运安装命令"等 Anti-Pattern，避免 AI 文档常见雷区。

安装配置

通过 Skillstore CLI 一键安装：npx skillstore add samber/golang-documentation，完成后即可在支持的 AI 工具中调用。
适合已配置 Go 1.22+ 开发环境的团队，安装后可立即让 Claude Code 读取本地 Go 源码并产出文档。
推荐在项目根目录准备 go.mod 与核心源码片段，便于 Skill 在 prompt 中引用真实声明和行为。
若要在 CI 中自动校验文档，可在仓库 workflows 中加入 go vet + gofmt -d 步骤，与 Skill 输出互相校验。

使用步骤

选定目标产物类型（library / application / CLI），并把核心 Go 源码、README 现状与 CHANGELOG 提交给 Skill。
调用"起草 package 注释"模板，让模型基于真实声明生成简洁、可被 godoc 渲染的 package 注释。
使用"构建 README 大纲"模板，结合仓库实际情况生成安装、快速开始、配置、用法、测试与支持章节。
针对公开 API 调用"添加可执行示例"模板，产出 ExampleXxx 测试函数并附上预期输出注释。
进入"审计项目文档"流程，逐项检查 API、README、CONTRIBUTING、CHANGELOG、CLI help 的一致性与可信度。
由维护者最终审阅、合并文档并发布版本，必要时配合 go doc 与 pkgsite 复验渲染效果。

适用场景

新发布的 Go 开源库需要按 godoc 规范撰写 package 注释与可执行示例。
既有 Go 服务的 README 与 CHANGELOG 内容陈旧，需要系统化重写与扩展。
团队希望统一多项目文档风格，避免新人 onboarding 时遇到差异巨大的注释质量。
准备生成给 LLM 消费的 llms.txt，提升自家 Go 库在 AI 检索中的曝光度。
CLI 工具需要把 --help 输出与文档保持一致，减少用户搜索命令用法的成本。
维护者做 PR 评审时希望快速识别注释缺失、示例无法运行或说明与实际不符。

适用人群

Go 开源库作者、内部 Go 服务维护者、技术文档工程师、DevRel、代码评审者与希望统一团队文档规范的技术 Lead。

工作原理

Skill 在 metadata 中预置了 Go 官方文档规范与 samber 团队长期实践的写作原则。Claude 调用时，Skillstore 会把 package 注释、Example 测试、README 章节、CHANGELOG 等模板注入到 prompt，让模型按字段填空并交叉引用源码，最后通过"审计项目文档"模板反向校验产物是否出现伪造 API、泛注释、未审搬运安装命令等 Anti-Pattern，从而在保证效率的同时不牺牲文档真实性。

官方链接

团队信息

AI产品库官方

由 AI 猎手自动发现

评论与建议

0 条评论