📱
ChatGPT intermediate

Estratégias de documentação em android em Android

Prompt gerado automaticamente para Documentação em Android em Android

2 usos Android

Prompt completo

"Gere um guia passo a passo, detalhado e acessível para desenvolvedores Android iniciantes, explicando como criar e gerenciar a documentação técnica de um projeto de aplicativo Android. O guia deve cobrir:

1. **Estrutura de pastas e arquivos recomendada** para a documentação (ex: `docs/`, `README.md`, `ARCHITECTURE.md`, `API_REFERENCE.md`).
2. **Ferramentas e linguagens** para escrita da documentação (Markdown, reStructuredText, KDoc/JavaDoc, Mermaid para diagramas, etc.), com exemplos de uso para cada uma.
3. **Boas práticas** de escrita (clareza, concisão, consistência, exemplos de código, diagramas).
4. **Tipos de documentação essenciais** (visão geral do projeto, arquitetura, instalação/setup, API, testes, contribuição).
5. **Integração com o processo de desenvolvimento** (CI/CD para gerar documentação, revisões de código com foco em documentação).
6. **Estratégias para manter a documentação atualizada** e sincronizada com o código.

O guia deve ser prático, incluir exemplos de código e trechos de documentação, e focar em soluções que possam ser facilmente implementadas em projetos de código aberto ou internos de equipes pequenas a médias."

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