image

Accede a bootcamps ilimitados y a más de 650 cursos

50
%OFF
Article image

JR

João Rangel10/02/2025 22:29
Compartir

Diretrizes de Construção de Projetos

    Estou escrevendo esse documento para padronizar a iniciação de qualquer projeto, seja em qual linguagem for e para qualquer objetivo que tiver , separei em 4 etapas para clarear a mente de quem seguir este guia para construção de projetos.

    ---

    Fase 1 - Introspecção / Surgimento da Ideia 

    Primeiramente, quando a Ideia Surge, a ANOTAMOS com todos detalhes, de forma descritiva e e logo em seguida devemos fazer essas 4 Perguntas:

    1. O Que Estou Fazendo ??

    2. Para o que/quem farei isso ??

    3. Por que Farei Isso ??

    4. Como fazer isso??

    Fase 2 - Definição de Escopo / Stack(s) utilizada(s) 

    Após definirmos quais são os objetivos da aplicação e o que ela é , chegamos na preparação do projeto que é justamente onde vamos definir qual será o ***escopo*** dele, sua ***arquitetura***, quais serão as ***langs*** utilizadas e os ***frameworks/libs*** usados:

    1. Qual é o alcance da minha aplicação??? 

    - (Qual é o objetivo principal dela ???? 

    - quais são as soluções???  

    - Qual Nome do Projeto??? ) -> **DOMÍNIO DO PROJETO** 

    2. Quais Serão as Features Principais do Projeto ???

      - (Quais Problemas Busca resolver???? 

      - Quais Serão as Especialidades??) 

    3. Qual Será a Arquitetura do Projeto ???

      - (Pense nas features, nas organizações de diretório(s) qual será o tipo de arquitetura???)

    4. Qual é a Stack Necessária Para Construir a Aplicação 

      - ( Pense em quais Langs Usar , Databases , FrameWorks, Gereciadores de Pacote, Git e etc)

    Fase 3 - Hands On (ou Quase Isso) 

    Agora que a preparação terminou devemos partir para a mão na Massa ou quase isso, pois depois do planejamento e antes da execução existe uma etapa primordial que é a parte de ler a documentação para definirmos quais serão os melhores recursos para otimizar o projeto , Dividir Para Conquistar e, Por Fim começar a codificar.

    1. Leitura de Documentação (Defina quais funcionalidades utilizar dos frameworks e dependencies do projeto )

    2. Crie o README.md do projeto e coloque todas informações que você definiu na etapa 2, isso deixará tudo mais claro na parte prática 

    3. Faça a Divisão Projeto em partes menores para poder elucidar a sua construção e melhorar o pensamento lógico a respeito da arquitetura

    4. Comece a escrever código pela fração mais acessível, juntamente a Raiz do Projeto, isso vai ajudar a construir os outros módulos do projeto

    Fase 4 - Finalização 

    Não Pense que o projeto acabou depois de ser escrito, ele vai muito além disso, entenda que o código é seu quadro em branco e você é o artista, mas para além disso, sua obra não é uma arte abstrata, por isso mesmo, ela deve ser fechada com chave de ouro:

    - Teste seu projeto como um todo, e se preciso for, depure feature a feature, só faça algo completo e funcional , seu código é sua obra-prima

    - Documente Seu Projeto, na maioria das vezes não escrevemos código para nós , mas sim para os outros, por isso , documente seu projeto de ponta a ponta , explicando que ele é , como funciona , como usar, e é claro , exibindo suas principais features 

    - Se o seu projeto é uma verdadeira obra-prima, ele deve ser visto então para isso , faça o seu deploy , soluções ajudam a todos

    Se Você leu até aqui eu agradeço pela atenção e lembre-se, isso não é um livro de regras e muito menos uma cartilha que deve ser rezada como um mantra, apenas uma das diversas formas de organizar projetos, esse documento serve mais como um guia do que qualquer outra coisa , muito obrigado pela atenção e ótimo trabalho

    Deixando Abaixo Meu GitHub:

    https://github.com/jota-dev00-0

    Site com esse documento:

    https://guia-de-projetos.vercel.app/#/

    Muito Obrigado Pela Leitura!

    Compartir
    Comentarios (1)
    DIO Community
    DIO Community - 11/02/2025 15:15

    Parabéns pelo artigo, João! Isso aqui é um verdadeiro guia estratégico para a construção de projetos e pode ser extremamente útil para quem deseja iniciar qualquer desenvolvimento com organização e clareza. A separação em quatro fases estruturadas torna o fluxo lógico muito mais acessível, ajudando tanto iniciantes quanto desenvolvedores experientes a não deixarem escapar pontos fundamentais na concepção de um projeto.

    Gostei bastante da fase de introspecção, pois muitas vezes subestimamos a importância de formular boas perguntas antes de começar um projeto. Saber o que, para quem, por que e como fazer um projeto pode evitar desperdício de tempo e recursos.

    Outra parte interessante é a fase de documentação. Muitas vezes, devs focam na implementação e esquecem de documentar adequadamente, o que dificulta a manutenção e a colaboração futura. A ideia de criar um README.md desde o início e pensar na arquitetura antes de começar a codificar são práticas que realmente fazem diferença no longo prazo.

    Talvez uma sugestão para complementar seja incluir um trecho sobre boas práticas de versionamento no Git, indicando padrões como Git Flow, convenção de commits e a importância de boas pull requests para quem trabalha em equipe. O que acha?

    Ótimo material!