Arborescence des fichiers

Voici l’organisation de la base software que je vous propose, en partant de la racine. Toute remarque, amélioration ou critique sera la bienvenue, le but étant que chacun s’y retrouve ! Bien sûr, il est possible que j’aie oublié des choses ou que vous ayez d’autres idées en tête, dans ce cas n’hésitez pas à m’en faire part.

root/
    doc/ # Répertoire contenant la documentation générale relative au projet (par exemple notre short paper SLTU ;)
        img/ # Images et schémas
    specs/ # Répertoire contenant toutes les spécifications
        mdf/ # Sous-répertoires pour la documentation relative à un sujet en particulier, ici un exemple pour MDF 4.0
        xml/ # Ou pour les formats XML envisagés
            dtd/ # Document Type Definition
            struct/ # Exemples de structure de fichier
        metadata/ # Proposition de template Excel pour les métadonnées
    dict/ # Répertoire propre aux dictionnaires
        common/ # Fichiers potentiellement communs à tous les dictionnaires
            toolbox/ # Projet Toolbox de base comportant notamment le fichier *.typ décrivant la structure hiérarchique des champs
            examples/ # Exemples de dictionnaires
        khaling/ # Un sous-répertoire par langue
            toolbox/ # Fichiers propres à l'outil Toolbox adaptés à ce dictionnaire en particulier
            lexique_pro/ # Fichiers propres à des projets sous Lexique Pro
            data/ # Sous-répertoire dédié aux données de ce dictionnaire
                audio/ # Ici, stockage des extraits sonores
                video/ # Stockage de vidéos s'il y en a
                txt/ # Entrées du dictionnaire, transcriptions, annotations, ...
        japhug/ # ...
    dev/ # Répertoire contenant le code à proprement parler, les bibliothèques et les scripts
        lib/ # Des bibliothèques que l'on va utiliser, modifier ou créer
            nltk/ # Natural Language Toolkit
            my_library/ # La bibliothèque que je souhaite créer
                doc/ # Documentation relative à l'interface de ma bibliothèque
                test/ # Tests unitaires et/ou fonctionnels
        scripts/ # Regroupe les scripts opérationnels utilisés par les chercheurs
            mdf2xml/ # Avec par exemple des sous-répertoires par fonctionnalité
                pl/ # Un sous-répertoire par langage de script, ici Perl
                    obj/ # Si des fichiers sont générés, par convention il le sont dans un répertoire "objet" séparé
                py/ # Scripts Python
            mdf2pdf/ # ...
        appli/ # Contient des applications (avec éventuellement interface graphique)
        tools/ # Outils qui peuvent nous être utiles et qu'on est susceptible de modifier ou d'adapter à nos besoins

Remarque concernant les règles de nommage des fichiers et répertoires : tous les fichiers et répertoires seront nommés en lettres minuscules, sans espace ni caractères spéciaux (on utilisera l’underscore ‘_’ en guise d’espace).

Langue utilisée : autant il est plus facile d’écrire les pages Wiki en français, autant pour le code en lui-même et les noms des fichiers et répertoires, il me paraît plus approprié de tout écrire en anglais, et ce pour deux raisons : d’une part, la plupart des développeurs codent et commentent leur code en anglais et j’ai donc pris cette habitude ; d’autre part, argument beaucoup plus convaincant je pense, avoir une base software en anglais permet de l’échanger beaucoup plus facilement avec d’autres qui pourraient être intéressés par notre travail.