O que é DESIGN.md?
É um arquivo de documentação que explica as decisões arquitetônicas e a lógica de design de um projeto de software.
Definição
É um guia nos processos de desenvolvimento de software que explica a estrutura básica do projeto e porque ele está estruturado desta forma. Geralmente está localizado no topo da pasta do projeto. Ele permite que os desenvolvedores entendam porque o projeto escolheu essa arquitetura.
Como funciona
Crie um arquivo chamado 'DESIGN.md' na pasta do projeto. Escreva o objetivo do projeto, as tecnologias selecionadas e os princípios de design. Ajude seus colegas de equipe a se adaptarem rapidamente ao projeto lendo este arquivo.
Onde é usado
Você o encontrará frequentemente em projetos de código aberto ou repositórios de software corporativo em plataformas como GitHub ou GitLab.
Costuma ser confundido com
Pode ser confundido com o arquivo README.md; Enquanto README explica como executar o projeto, DESIGN.md explica por que o projeto foi projetado dessa forma.
Perguntas frequentes
Por que preciso de um arquivo de design separado?
À medida que o código se torna mais complexo, é necessário não esquecer a lógica das decisões tomadas e facilitar a compreensão do sistema pelos recém-chegados.
Termos relacionados
Ferramentas relacionadas
Esta explicação foi escrita em linguagem simples para a TreScout e traduzida automaticamente do original em turco · a versão turca é a que vale. Se algo parecer errado ou faltando, escreva para hello@trescout.com. Ler em turco →