x-doc-go

What problem does it solve?

This Skill prevents Go packages from becoming hard to understand and risky to reuse by enforcing a consistent contract via doc.go, complete Russian doc-comments, and testable examples.

Core Features & Use Cases

• doc.go as a package contract: ensures each (non-cmd/non-mocks) package defines a clear contract that explains what it implements, how to create it, which environment variables it supports, and what lifecycle/usage constraints apply.
• Exported symbol documentation enforcement: requires every exported type/function/method to have a full Russian doc-comment sentence ending with a period, enabling reliable discovery and review.
• Example-driven clarity: encourages adding Go Example tests when they replace or validate documentation snippets, keeping docs and behavior in sync.
• Smoke-check workflow: provides an automated way to run a doc.go structure check via the included script.

Quick Start

Ask the assistant to review or fix the target Go package by adding/updating doc.go and ensuring all exported symbols have proper Russian doc-comments, then run the doc.go smoke-check for that package directory.