golang-documentation

To set up Go documentation, use this Skill to scaffold godoc comments, README templates, CONTRIBUTING, CHANGELOG, and an AI-friendly llms.txt. It organizes these best practices into a reusable unit for both libraries and applications.

Making Go documentation AI-friendly involves creating an llms.txt file alongside standard godoc comments and API docs. This Skill provides templates to generate these artifacts, enabling AI agents to quickly discover and review your code.

Yes, you can use Go Playground snippets and Example tests for documentation. This Skill incorporates lightweight play and Examples into its workflow to provide executable, playground-ready snippets for API review and onboarding.

Yes, this Go documentation approach works for both libraries and CLI applications. It applies consistent documentation workflows, templates, and AI-friendly artifacts across different project types to ensure uniform coverage.

To audit existing Go project documentation, use the AI-assisted workflows in this Skill to check for standard godoc comments, README conventions, CONTRIBUTING guidelines, and an llms.txt file, ensuring comprehensive coverage and consistency.