技能 golang-documentation

📦

golang-documentation

Name: golang-documentation
Author: samber

v1.3.2 内容修订 r1 安全 🌐 网络访问⚙️ 外部命令📁 文件系统访问⚡ 包含脚本

Write Clear Go Documentation

Go projects often have incomplete comments, examples, and contributor guidance that slow adoption and maintenance. This skill provides structured guidance for writing, reviewing, and organizing documentation that matches Go conventions.

支持: Codex Code(CC)

🥇 83 黄金

使用我的智能体安装

将此请求复制给你的智能体，其中包含权威 Skill 页面和清单。

智能体请求

Review the Skillstore skill "golang-documentation" from https://skillstore.io/skills/samber-golang-documentation.md and its manifest at https://skillstore.io/api/skills/samber-golang-documentation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

你的智能体仍应展示其计划，并按安全策略请求必要确认。

Agent 可读资源

当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。

Markdown 详情 GET /skills/samber-golang-documentation.md 已签名 manifest GET /api/skills/samber-golang-documentation/manifest 已签名 lockfile GET /api/skills/samber-golang-documentation/lockfile

测试它

正在使用“golang-documentation”。 A Go package with exported types and methods but sparse comments.

预期结果:

A package overview, convention-compliant API comments, and focused examples that explain behavior and edge cases.

正在使用“golang-documentation”。 A CLI repository needing onboarding and release documentation.

预期结果:

A task-oriented README structure
A contribution guide with local setup and validation steps
A changelog entry following the chosen release format

正在使用“golang-documentation”。 A draft Example test and its expected output.

预期结果:

A reviewed example with clearer naming, deterministic output, and documentation notes for users.

安全审计

安全

v1 • 2026/9/6 打开版本化报告

All 101 static findings were reviewed against their snippets. They are false positives caused by Markdown backticks, documentation URLs, example paths, code samples, and evaluator text; no executable malware behavior or prompt injection evidence was found. The skill remains documentation-focused, but installation examples should be reviewed before use.

已扫描文件

2,021

分析行数

复核项

已忽略误报

风险因素

🌐 网络访问 (17)

assets/templates/CONTRIBUTING.md:15 evals/evals.json:35 evals/evals.json:424 evals/evals.json:453 evals/evals.json:461 references/code-comments.md:95 references/code-comments.md:217 references/library.md:50 references/library.md:169 references/project-docs.md:84 SKILL.md:12 SKILL.md:129 SKILL.md:167 SKILL.md:176 SKILL.md:182 SKILL.md:185 SKILL.md:236

⚙️ 外部命令 (50)

evals/evals.json:7 evals/evals.json:24 evals/evals.json:35 evals/evals.json:63 evals/evals.json:88 evals/evals.json:105-116 evals/evals.json:116 evals/evals.json:144 evals/evals.json:172 evals/evals.json:200-228 evals/evals.json:228 evals/evals.json:256 evals/evals.json:284 evals/evals.json:312-340 evals/evals.json:340-396 evals/evals.json:396 evals/evals.json:424 evals/evals.json:452 evals/evals.json:457-461 evals/evals.json:461-508 evals/evals.json:508 evals/evals.json:564 references/application.md:33-34 references/application.md:42-44 references/application.md:58-66 references/application.md:66-67 references/application.md:67 references/application.md:68 references/application.md:69 references/project-docs.md:70-82 references/project-docs.md:82 SKILL.md:24 SKILL.md:31 SKILL.md:39 SKILL.md:40 SKILL.md:41 SKILL.md:42 SKILL.md:52 SKILL.md:54 SKILL.md:56 SKILL.md:58 SKILL.md:64 SKILL.md:66 SKILL.md:69 SKILL.md:76 SKILL.md:85 SKILL.md:92 SKILL.md:105 SKILL.md:114-146 SKILL.md:146-148

📁 文件系统访问 (5)

evals/evals.json:133 references/application.md:58 references/application.md:74 references/application.md:58 references/application.md:74

⚡ 包含脚本 (2)

references/code-comments.md:276-280 references/library.md:80-83

最新一次完成的静态与语义审计未检测到已确认的安全发现。这并不能证明该 Skill 没有副作用。

审计者: claude

分享与引用此报告

分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。

打开版本化报告

复制报告链接

https://skillstore.io/skills/samber-golang-documentation/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 徽章

[![Skillstore security assessment](https://skillstore.io/badges/skills/samber-golang-documentation/security.svg)](https://skillstore.io/skills/samber-golang-documentation?utm_source=security_passport_badge)

HTML 徽章

<a href="https://skillstore.io/skills/samber-golang-documentation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/samber-golang-documentation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

嵌入卡片

<iframe src="https://skillstore.io/embed/skills/samber-golang-documentation.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

学术引用 (APA · BibTeX · CFF)

APA 引用

samber. (2026). golang-documentation security audit report (audit version 1) [Author version 1.3.2]. Skillstore. https://skillstore.io/skills/samber-golang-documentation/audits/1

BibTeX 引用

@techreport{samber-samber-golang-documentation-2026,
  author = {samber},
  title = {golang-documentation security audit report (audit version 1)},
  institution = {Skillstore},
  year = {2026},
  number = {1},
  url = {https://skillstore.io/skills/samber-golang-documentation/audits/1},
  note = {Author version 1.3.2}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "golang-documentation security audit report (audit version 1)"
version: "1.3.2"
type: report
authors:
  - name: "samber"
date-released: "2026-09-06"
url: "https://skillstore.io/skills/samber-golang-documentation/audits/1"
identifiers:
  - type: other
    value: "skillstore:samber-golang-documentation:audit:1"
    description: "Skillstore immutable audit report identifier"

Skillstore 评分

评分依据证据置信度: 中

架构

100

可维护性

内容

社区

100

规范符合性

你能构建什么

Document a Go library

Generate package comments, API explanations, examples, and README sections from supplied Go declarations and behavior.

Improve an application guide

Organize setup, configuration, operations, architecture, and troubleshooting content for a Go service or CLI.

Review a documentation change

Assess comments, examples, contribution guidance, and release notes for clarity, completeness, and consistency.

试试这些提示

Start with a package comment

Write a concise package comment for this Go package. Use only facts in the supplied code and state its main purpose.

Build a README outline

Create a README outline for this Go project using the supplied repository details. Include installation, quick start, configuration, usage, testing, and support sections.

Add executable examples

Write Go ExampleXxx test functions for the supplied public API. Include realistic inputs, expected output comments, and cases that clarify important behavior.

Audit project documentation

Review the supplied Go project documentation as a maintainer. Identify unsupported claims, missing usage context, inconsistent terminology, and gaps across API docs, README, CONTRIBUTING, CHANGELOG, and CLI help. Propose precise revisions.

最佳实践

Provide the relevant code and project facts, then ask for documentation grounded only in that evidence.
Prefer runnable, deterministic examples that show one important behavior at a time.
Review generated text with maintainers and run project checks before publishing.

避免

Do not invent APIs, commands, configuration keys, versions, or compatibility claims.
Do not use generic comments that merely repeat an identifier without explaining behavior.
Do not copy installation commands or external links into production guidance without reviewing their source and safety.