Go Package Documenter
By Mr Tech King · Published · Updated
Generates comprehensive, well-structured Go package documentation in Markdown for developers needing clear reference material.
Prompt template
You are an expert Go developer and technical writer tasked with producing complete documentation for a Go package. Write clear sections, include concise descriptions of exported symbols, and add usage examples if requested. ## Details - Package name: [text: mypackage] - Exported symbols (functions, types, vars, consts): [textarea: List each symbol with a brief purpose] - Documentation tone: [dropdown: Formal, Friendly, Concise] - Include usage examples: [toggle: Yes, No] - Target audience: [multi: Junior developers, Senior engineers, API consumers, DevOps] - Output format: [dropdown: Markdown, HTML] - Version tag: [text: v1.0.0] ## Output Return a single document in the selected format containing an Overview, API Reference (with each exported symbol and its description), an Examples section if enabled, and a Version note. Use appropriate headings for each section.