¿Qué es DESIGN.md?
Es un archivo de documentación que explica las decisiones arquitectónicas y la lógica de diseño de un proyecto de software.
Definición
Es una guía en los procesos de desarrollo de software que explica la estructura básica del proyecto y por qué se estructura de esta manera. Generalmente se encuentra en la parte superior de la carpeta del proyecto. Permite a los desarrolladores comprender por qué el proyecto eligió esta arquitectura.
Cómo funciona
Cree un archivo llamado 'DESIGN.md' en la carpeta del proyecto. Escriba el propósito del proyecto, las tecnologías seleccionadas y los principios de diseño en su interior. Ayude a sus compañeros de equipo a adaptarse rápidamente al proyecto leyendo este archivo.
Dónde se usa
A menudo lo encontrará en proyectos de código abierto o repositorios de software empresarial en plataformas como GitHub o GitLab.
Suele confundirse con
Puede confundirse con el archivo README.md; Mientras README le indica cómo ejecutar el proyecto, DESIGN.md explica por qué el proyecto se diseñó de esa manera.
Preguntas frecuentes
¿Por qué necesito un archivo de diseño separado?
A medida que el código se vuelve más complejo, es necesario no olvidar la lógica de las decisiones tomadas y facilitar la comprensión del sistema a los recién llegados.
Términos relacionados
Herramientas relacionadas
Esta explicación se redactó en lenguaje sencillo para TreScout y se tradujo automáticamente del original en turco · prevalece la versión turca. Si algo le parece erróneo o incompleto, escriba a hello@trescout.com. Leer en turco →