SuperAPI AI 工具集

golang-documentation

编程与开发

查看项目

更新于 10-16 08:44

技能介绍

用途:为 Go 项目生成或审查文档,服务人类读者与 AI 智能体,让代码可发现、可理解、可维护。作者定位为 Go 技术写作者与 API 设计者。

主要能力:分写入模式(补齐 doc 注释、README、CONTRIBUTING、CHANGELOG、llms.txt)与审查模式(按文档层级最多并行 5 个子智能体检查完整性、准确性与风格)。先区分项目类型:库(无 main 包,侧重 godoc、ExampleXxx、Playground、pkg.go.dev)与应用程序/CLI(有 main 包或 cmd/,侧重安装说明、CLI 帮助文本、配置文档),两类共用函数注释、README、CONTRIBUTING、CHANGELOG。

必要内容:导出函数的 doc 注释、包注释(// Package foo...,必须存在)、README.md、LICENSE、快速开始、可运行代码示例;CONTRIBUTING、CHANGELOG 或 GitHub Releases 建议提供;库额外建议 ExampleXxx、Go Playground 演示、llms.txt。README 按标题、徽章、摘要、演示、快速开始、功能、贡献、贡献者、许可证的顺序组织。

用法要点:注释以函数名开头,解释为何与何时使用,而非复述签名;用 // Play: URL 链接演示;ExampleXxx 写在 _test.go 中,由 go test 验证;库安装命令为 go get github.com/{owner}/{repo},应用可用 go install github.com/{owner}/{repo}@latest 或 Docker 拉取。API 文档优先由注解自动生成,如 OpenAPI 3.x 用 swaggo/swag。

限制与边界:不虚构理由、营销词或未来承诺;编辑时保持 must/should/may 等情态与条件、警告不变;私有项目不必提供文档网站、llms.txt 或 Playground 演示;多方技能冲突时公司技能优先;严格受控英语可参考相关 humanizer 技能。本资料未提供收费、价格与具体平台效果等信息。