Junior — Middle
Criaste documentação ou descrições textuais para os teus projetos?
sobes.tech IA
Resposta da IA
Sim, a criação de documentação e descrições de texto é uma parte importante do desenvolvimento de projetos. A documentação ajuda a:
- Transmitir conhecimentos aos novos membros da equipa.
- Registar decisões arquitetónicas e lógica de negócio.
- Facilitar o suporte e desenvolvimento do projeto.
Nos meus projetos, escrevi especificações técnicas, ficheiros README, comentários no código e instruções de uso. Por exemplo, para uma aplicação Android, pode-se descrever a estrutura do projeto, as bibliotecas utilizadas, as interfaces API e os cenários de uso.
Exemplo de um README simples para um projeto Android:
# MyApp
Aplicação para acompanhamento de tarefas.
## Funcionalidades
- Adicionar, editar e eliminar tarefas
- Notificações de prazos
## Tecnologias utilizadas
- Kotlin
- Room para base de dados local
- Retrofit para pedidos de rede
## Como iniciar
1. Clonar o repositório
2. Abrir no Android Studio
3. Executar num emulador ou dispositivo
Este método facilita a compreensão e o suporte do projeto.