Qu'est-ce que DESIGN.md ?
Il s'agit d'un fichier de documentation qui explique les décisions architecturales et la logique de conception d'un projet logiciel.
Définition
Il s'agit d'un guide des processus de développement logiciel qui explique la structure de base du projet et pourquoi il est structuré de cette façon. Il est généralement situé en haut du dossier du projet. Cela permet aux développeurs de comprendre pourquoi le projet a choisi cette architecture.
Comment ça marche
Créez un fichier nommé « DESIGN.md » dans le dossier du projet. Écrivez à l'intérieur le but du projet, les technologies sélectionnées et les principes de conception. Aidez vos coéquipiers à s'adapter rapidement au projet en lisant ce dossier.
Où est-ce utilisé
Vous le rencontrerez souvent dans des projets open source ou des référentiels de logiciels d'entreprise sur des plateformes comme GitHub ou GitLab.
Souvent confondu avec
Il peut être confondu avec le fichier README.md ; Alors que README vous indique comment exécuter le projet, DESIGN.md explique pourquoi le projet a été conçu de cette façon.
Questions fréquentes
Pourquoi ai-je besoin d’un fichier de conception séparé ?
À mesure que le code devient plus complexe, il ne faut pas oublier la logique des décisions prises et faciliter la compréhension du système par les nouveaux arrivants.
Termes liés
Outils liés
This explanation was written in plain language for TreScout · translated from the Turkish original. If something looks wrong or missing, write to hello@trescout.com. Read in Turkish →