Prompt completo
"Considerando o cenário atual de desenvolvimento Android, onde a fragmentação de APIs e a rápida evolução das tecnologias (Kotlin, Jetpack Compose, etc.) são constantes, e a necessidade de manter a documentação técnica acessível e atualizada para desenvolvedores de diferentes níveis de experiência: **Crie um guia interativo e dinâmico que auxilie desenvolvedores Android a gerar e manter documentação técnica de alta qualidade, focando em:** 1. **Melhores práticas para documentar código (Javadoc/KDoc):** Como escrever comentários claros, concisos e úteis para classes, métodos, parâmetros e retornos, e a importância de exemplos de uso. 2. **Geração automatizada de documentação (ex: Dokka):** Como configurar e utilizar ferramentas para gerar HTML, Markdown ou outros formatos a partir do código-fonte, e como integrar isso ao pipeline de CI/CD. 3. **Documentação de arquitetura e design:** Estratégias para documentar decisões de arquitetura (MVVM, MVI, Clean Architecture), padrões de design e fluxos de dados complexos, utilizando diagramas (UML, Mermaid) e descrições textuais. 4. **Documentação para bibliotecas e SDKs (públicos e privados):** Conteúdo essencial (introdução, instalação, exemplos de uso, referências de API, changelog, troubleshooting) e ferramentas para sua publicação (ex: GitHub Pages, KDoc). 5. **Manutenção e atualização da documentação:** Estratégias para garantir que a documentação permaneça relevante e sincronizada com o código, incluindo automação de testes de links quebrados e integração com sistemas de controle de versão. O guia deve ser estruturado como uma **jornada passo a passo**, com exemplos práticos em Kotlin e XML/Jetpack Compose, e deve considerar ferramentas e plataformas populares no ecossistema Android. A linguagem deve ser didática e motivadora, incentivando a cultura de documentação como parte integral do processo de desenvolvimento."
Tags relacionadas
Android
Documentação em Android
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de Android
ChatGPT
Guia para testing em android em Android
Prompt gerado automaticamente para Testing em Android em Android
4 usos
ChatGPT
Guia para padrões de design em android em Android
Prompt gerado automaticamente para Padrões de design em Android em Android
4 usos
ChatGPT
Guia para testing em android em Android
Prompt gerado automaticamente para Testing em Android em Android
5 usos