go-documentation

What it does

This skill enables AI agents to automatically generate, update, and maintain comprehensive documentation specifically for Go (Golang) projects. It parses source code to extract function signatures, comments, and usage patterns into structured markdown or standard doc formats.

When to use it

• Onboarding new developers: Quickly create a reference guide so team members can understand the codebase without reading every file.
• API maintenance: Automatically regenerate API documentation whenever functions are modified or new endpoints are added.
• Code review support: Generate summary docs for complex modules before they are merged into the main branch.
• External integration: Produce clean, formatted documentation files to share with third-party developers or clients.

Key capabilities

• Parses Go source code to identify functions, methods, and structs.
• Extracts existing comments and docstrings to build coherent narratives.
• Outputs documentation in standard markdown format ready for deployment.
• Maintains consistency in formatting across large codebases.

Example prompts

• "Generate a complete README.md file for my Go project using the go-documentation skill."
• "Update the documentation for the auth package based on recent changes in the source code."
• "Create a structured API reference guide from the functions defined in handlers.go."

Tips & gotchas

Ensure your Go code includes clear comments or docstrings, as the skill relies heavily on these to generate accurate descriptions. For best results, run this skill after significant refactoring to keep documentation synchronized with the latest logic.