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

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

5.0
40 usos
ChatGPT
Usar no ChatGPT
"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."

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de Android

Continue explorando prompts nesta categoria.

Guia para testing em android em Android

Prompt gerado automaticamente para Testing em Android em Android

Guia para padrões de design em android em Android

Prompt gerado automaticamente para Padrões de design em Android em Android

Guia para testing em android em Android

Prompt gerado automaticamente para Testing em Android em Android