doc-hunter-go

Detect missing why documentation and godoc in Go codebases.

5|Updated Jan 14, 2026
One-click install
npx skills add https://github.com/skyosev/agent-skills --skill doc-hunter-go
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-hunter-go
Source: https://github.com/skyosev/agent-skills/tree/main/hunter-party-go/doc-hunter-go
Command: npx skills add https://github.com/skyosev/agent-skills --skill doc-hunter-go

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit Go code for missing "why" documentation — ensuring rationale behind decisions is captured and hard-to-understand code is easier to maintain.

Core Features & Use Cases

  • Detect missing inline explanations for non-obvious logic.
  • Flag lack of godoc on exported symbols and package-level comments.
  • Provide guidance on where documentation should exist to support long-term maintainability and handoffs.

Quick Start

Review the target Go package and annotate non-obvious decisions with concise explanations of why they exist.

Frequently Asked Questions about doc-hunter-go

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

FAQPage Schema
How do I find missing 'why' documentation in a Go codebase?

To find missing 'why' documentation in Go code, audit the codebase to detect undocumented business rules and flag non-obvious logic lacking inline rationale. This clarifies hard-to-understand decisions for future maintainability.

What is the best way to audit Go code for missing godoc on exported symbols?

Auditing Go code for missing godoc involves reviewing exported symbols and package-level comments to flag undocumented declarations. This ensures non-obvious decisions are captured, supporting long-term maintainability and easier handoffs.

Can I use static analysis to prepare a Go codebase for team handoffs?

Yes, static analysis can prepare a Go codebase for handoffs by detecting missing rationale behind non-obvious decisions and insufficient package-level comments. It outputs structured recommendations to clarify internal libraries and services.

When do I need to add 'why' docs to Go code during a code review?

You need to add 'why' docs during Go code reviews when non-obvious logic and business rules lack inline explanations. Capturing the rationale behind these decisions ensures the codebase remains easier to maintain.

Does this Go documentation audit work on both internal libraries and services?

Yes, this Go documentation audit applies to review sessions across both internal libraries and services. It detects missing rationale and outputs structured recommendations to clarify non-obvious decisions during onboarding and handoffs.