skills.rest
omarluq
omarluqCOMMUNITY
Explore all skills by this author →
Website𝕏@omarluqqGitHub

golang-documentation

Generate Go project documentation with godoc comments, README templates, and llms.txt.

5|1|Updated Apr 14, 2026
Search Tags:#documentation#discovery#golang#llms.txt#playground#godoc#example-tests
One-click install
npx skills add https://github.com/omarluq/og-template --skill golang-documentation-omarluq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: golang-documentation
Source: https://github.com/omarluq/og-template/tree/main/.agents/skills/golang-documentation
Command: npx skills add https://github.com/omarluq/og-template --skill golang-documentation-omarluq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Go projects often lack clear, machine-friendly documentation that helps both human readers and AI agents navigate code, understand intent, and reuse components effectively.

Core Features & Use Cases

  • Comprehensive godoc coverage for exported symbols and types, including explicit parameter and return value explanations.
  • Package-level and file-level comments that explain architecture, constraints, and rationale.
  • README templates, CHANGELOG guidance, and llms.txt to improve discoverability and AI-assisted tasks.
  • Example test functions and Play links to showcase usage and keep docs verified by tests.
  • Guidance for library vs application documentation, plus discoverability registrations.

Quick Start

Provide a ready-to-use documentation scaffold for a repository by applying the recommended structure: doc comments, README templates, CHANGELOG, and Discoverability artifacts, then adapt for the target project.

Frequently Asked Questions about golang-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Go documentation for both human readers and AI agents?▼

To generate Go documentation for both audiences, you need structured godoc comments for exported symbols alongside an llms.txt file and README templates that improve discoverability and help AI-assisted tasks navigate code and intent.

What is the best way to structure godoc comments for a Go library?▼

The best way to structure godoc comments is to provide comprehensive coverage for exported symbols and types with explicit parameter and return value explanations, supplemented by package-level comments explaining architecture, constraints, and rationale.

How do llms.txt files improve Go project discoverability?▼

llms.txt files improve Go project discoverability by providing a machine-friendly documentation format that helps AI agents navigate code, understand intent, and reuse components effectively alongside standard READMEs and CHANGELOG guidance.

Can I use example tests to verify my Go documentation?▼

Yes, you can use example test functions and Play links to showcase usage and keep your Go documentation verified by tests, ensuring that your README templates and godoc examples remain accurate and executable.

Does Go documentation differ between applications and libraries?▼

Yes, Go documentation differs between applications and libraries, requiring tailored guidance for each type to ensure standardized structure, discoverability registrations, and appropriate coverage for exported symbols and package-level architecture.

Related Skills

Explore More Software Engineering Skills→
muratmirgunmuratmirgun
8

go-documentation

Identify missing or weak godoc for exported Go APIs and examples.

Community
Advanced
ChrisnewgearChrisnewgear

ai-seo

Analyze website content for AI search engine visibility and citation readiness.

Community
Advanced
cxuucxuu
139

go-documentation

Standardize Go doc comments, package docs, and godoc formatting.

Community
Advanced
sambersamber
2.9k

golang-documentation

Design Go documentation workflows for godoc, README, CHANGELOG, and llms.txt artifacts.

Community
Advanced