Prompt para documentação em go em Go

**Prompt:**

"Você é um engenheiro de software sênior com vasta experiência em Go. Sua tarefa é criar um guia abrangente e prático para o desenvolvimento de documentação de código em projetos Go, focando em como garantir que essa documentação seja sempre atualizada e útil para outros desenvolvedores. O guia deve abordar as seguintes seções, com exemplos de código quando aplicável:

1.  **Boas Práticas de Comentários (Godoc):**
    *   Quando e como usar comentários de linha (`//`) e de bloco (`/* */`).
    *   Convenções de Godoc para pacotes, funções, structs, interfaces e variáveis (ex: primeira frase como resumo, uso de `//go:generate`).
    *   Como gerar documentação HTML a partir de Godoc (`go doc`).

2.  **Documentação de APIs (OpenAPI/Swagger):**
    *   A importância de documentar APIs RESTful em Go.
    *   Ferramentas e bibliotecas populares para gerar especificações OpenAPI a partir do código Go (ex: `swag`, `go-swagger`).
    *   Como adicionar anotações/tags no código Go para metadados OpenAPI.
    *   Visualização e teste da documentação gerada (Swagger UI).

3.  **Documentação de Pacotes e Módulos (READMEs e Exemplos):**
    *   Conteúdo essencial para um arquivo `README.md` de um módulo Go.
    *   A criação de exemplos de uso (`_example` packages ou arquivos `_test.go` com exemplos documentados) e como eles são exibidos pelo Godoc.
    *   Como linkar para documentação externa ou recursos relevantes.

4.  **Automação e Manutenção:**
    *   Estratégias para integrar a geração de documentação ao pipeline de CI/CD (ex: hooks de pre-commit, jobs de build).
    *   Como automatizar a verificação de inconsistências entre código e documentação (linters específicos para documentação).
    *   Dicas para incentivar a cultura de 'documentação como código' na equipe.

O tom deve ser técnico, claro e conciso, direcionado a desenvolvedores Go que buscam melhorar a qualidade e a sustentabilidade da documentação de seus projetos."