Percebi que há vários desenvolvedores juniores na comunidade de desenvolvimento de software em busca de idéias para portfólio ou para expandir seus conhecimentos técnicos.
Idealmente, um aplicativo para este fim não deve ser muito simples, pois os participantes perderiam o interesse; nem muito difícil, pois demandaria muito tempo ou estaria além das capacidades esperadas de um iniciante. Além disso, é bom restringirmos a algum problema com fins práticos, já que problemas abstratos podem ser encontrados em plataformas como HackerRank ou LeetCode.
Minha idéia é especificar os requisitos de um aplicativo, porém sem especificar qual tecnologia utilizar. Dessa forma, o projeto fica bastante genérico e abrangente, permitindo que qualquer pessoa possa participar.
Esta idéia estará em constante evolução, sendo esta a versão v0.1. Vou deixar o conteúdo deste texto neste GitHub. Estou aberto a comentários e novas idéias. Todos são bem-vindos a criar pull requests no projeto.
Note
Quando necessario, vou colocar algumas notas técnica para exclarecimento.
Um dia qualquer, você vai almoçar com alguns amigos e um deles te apresenta ao Geraldo. Seu amigo comentou com Geraldo que você está aprendendo desenvolvimento de software. Geraldo é muito carismático e te explica um pouco da rotina dele, dizendo:
"Trabalho em uma empresa de médio porte e nosso escritório fica na região suburbana. Temos vários cubículos, algumas salas e um pequeno showroom para mostrar nosso trabalho para potenciais clientes. Além disso, temos um galpão com vários itens para ajudar no funcionamento da empresa. Lá você vai encontrar de tudo um pouco, incluindo: material de escritório, equipamento de manutenção da propriedade, equipamento de áudio e até equipamento de pesca. Nosso chefe adora pescar e, de vez em quando, os funcionários vão pescar juntos em um lago próximo ao nosso escritório."
"Pois então, eu gostaria de falar de um probleminha que temos em nosso galpão. Para ser franco, nós temos um péssimo controle do que entra e sai daquele galpão. Nunca tivemos furto, pelo menos não estou ciente de nenhum, contudo é difícil saber o que está no galpão em um determinado momento. Se algum item não está no galpão, temos que ficar enviando mensagens para os funcionários procurando saber quem está com o quê. Eu deixei um livro na entrada do galpão, e agora quem pegar ou devolver um item tem que escrever o que foi retirado ou devolvido. A idéia é boa, mas tem problemas; quando quero saber o inventário do galpão, tenho que ler várias entradas do livro para ter uma idéia dos itens do galpão. Às vezes, desisto do livro e saio olhando no galpão mesmo."
"Bom, acho que você já entendeu o problema que quero resolver. Eu poderia criar uma tabela no Excel para resolver este problema. Contudo, gostaria de algo melhor do que o Excel, pois no futuro, eu quero implementar esta mesma solução em outros escritórios de nossos clientes que disseram ter o mesmo problema. No futuro, até imagino colocar uma maquininha tipo aquelas de supermercado para ler código de barras que identifica o produto na retirada ou devolução. Vai ficar show."
"Você toparia desenvolver este software comigo?"
Vocês acertam a forma de pagamento e Geraldo está muito entusiasmado com a idéia. Ele te convida para visitar a sede da empresa e você confirma que o que Geraldo disse é verdade. Na verdade, as coisas são um pouco piores do que ele disse, mas a essência do que ele te contou está correta. Geraldo começa a pensar em um nome para o aplicativo; ele sugere "Empresta Fácil", mas nada está decidido ainda.
Antes de começarmos a codificar, é uma boa idéia pensar em como o software vai funcionar de maneira geral. Devemos identificar os problemas concretos que os usuários do aplicativo estão enfrentando e como o aplicativo pode solucionar esses problemas. Por exemplo, podemos identificar alguns problemas óbvios: não saber o inventário com precisão e não saber qual funcionário está com determinado item. Podemos assumir alguns outros problemas, por exemplo, saber qual a data prevista de devolução, mas observe que este requisito nunca foi mencionado. Pode até ser uma boa idéia, mas por enquanto, vamos deixar o escopo o menor possível.
Primeiro vamos focar no mais importante: os empréstimos. Antes de realizarmos um empréstimo, temos que saber qual o item a ser emprestado para uma pessoa; ou seja, a funcionalidade de empréstimo depende de outras funcionalidades, portanto, temos que implementar as dependências primeiro.
Para emprestar um item, teremos que:
- Cadastrar a pessoa que vai pegar emprestado.
- Cadastrar o item que vai ser emprestado.
- Realizar o empréstimo.
Na perspectiva do aplicativo, teremos o seguinte fluxograma:
---
title: ... Emprestar Items ...
---
flowchart TD;
A( Iniciar aplicativo)
A --> |Acessar interface de cadastro de pessoa| B
B[Salvar dados da pessoa]
B --> |Acessar interface de cadastro de item| C
C[Salvar dados do item]
C --> |Acessar interface de empréstimo| D
subgraph Empréstimo
D[Selecionar uma pessoa]
D --> E
E[Selecionar um item]
E --> F
F[Confirmar empréstimo]
end
F --> G
G( Terminar aplicativo )
Note
Neste projeto, quando utilizamos o termo "acessar interface", estamos nos referindo a qualquer interface do aplicativo. Se o programador optar por codificar um aplicativo web, então a interface seria uma página web. Se o programador optar por um aplicativo de linha de comando, então a interface seria um comando. Se o programador optar por uma REST API, então a interface seria um endpoint. E assim por diante.
Note
Neste projeto vamos ignorar as permissões e dizer que o usuário do nosso sistema tem acesso a todas as funcionalidades do sistema.
Neste ponto, precisamos de uma quantidade pequena de dados para atender aos nossos requisitos. Vamos simplificar ao máximo os requisitos e ter apenas duas entidades: pessoa e item, ambas com os atributos id e nome. Contudo, também precisamos representar o empréstimo de alguma forma. A maneira mais simples seria criar uma associação na entidade pessoa para indicar que uma pessoa pode pegar um ou mais itens emprestados.
classDiagram
Pessoa *-- "0..*" Item : Pegar emprestado
class Pessoa{
-id : int
-name : string
}
class Item{
-id : int
-name : string
}
Note
Este diagrama de classes é apenas uma sugestão; você pode modelar o seu sistema como quiser.
É importante observar que as pessoas podem pegar itens emprestados por meio de uma agregação com a cardinalidade de um para muitos (0..*). Podemos dizer que uma pessoa pode ter muitos itens emprestados e um item pode estar emprestado para apenas uma pessoa. Em orientação a objetos, a classe Pessoa teria uma coleção (por exemplo, uma lista) de Itens como atributo.
Com base no fluxograma de empréstimos, fica fácil extrair as nossas primeiras histórias (também conhecidas como User Stories ou Cards). Vou seguir o modelo que encontrei no site Atlassian: Agile User Stories, apenas como referência. Cada time tem suas preferências.
Na prática, histórias podem ser quebradas em tarefas para que os desenvolvedores possam trabalhar. Exemplos de tarefas seriam: criar migração no banco de dados, automatizar o deploy da aplicação, codificar, testar em ambiente de validação. Não vou quebrar em tarefas neste projeto; isso fica a seu critério.
Como um administrador do sistema, eu quero cadastrar uma pessoa, para que eu possa emprestar itens para pessoas.
Esta história estará concluída quando:
- O administrador do sistema conseguir acessar a aplicação.
- O administrador do sistema conseguir acessar a interface de cadastro de pessoas.
- O administrador do sistema conseguir salvar os dados da pessoa na aplicação.
Como um administrador do sistema, eu quero cadastrar um item, para que eu possa emprestar itens para pessoas.
Esta história estará concluída quando:
- O administrador do sistema conseguir acessar a aplicação.
- O administrador do sistema conseguir acessar a interface de cadastro de itens.
- O administrador do sistema conseguir salvar os dados do item na aplicação.
Como um administrador do sistema, eu quero emprestar um item para uma pessoa, para que eu possa saber quais itens estão emprestados para quais pessoas.
Esta história estará concluída quando:
- O administrador do sistema conseguir acessar a aplicação.
- O administrador do sistema conseguir acessar a interface de empréstimos.
- O administrador do sistema conseguir salvar os dados do empréstimo.
- Adicionar QR Code para os itens
- Adicionar categorias para os itens
- Adicionar data de empréstimo
- Adicionar dados adicionais ao item: número de série, marca, modelo, cor
- Pesquisar pessoas pelo nome
- Pesquisar itens pelo nome
- Pesquisar itens por atributos