Je suis un développeur amateur et tous mes programmes jusqu'à présent étaient assez simples pour être documentés dans le code. En lisant le code, il était clair ce que je faisais telle ou telle action (mon test standard consistait à regarder le code 6 mois plus tard et à tout comprendre à la première lecture - et ma mémoire est courte).
Je suis maintenant confronté à un programme qui dépasse mes capacités à se souvenir des diverses interactions entre
- le code lui-même
- les index de la base de données
- les interactions entre les différents modules (code de base "travailleur" et "bibliothèque")
Ma documentation actuelle est un tableau blanc où j'ai toutes sortes de boîtes et de flèches qui pointent vers du code, vers des index de base de données, vers des actions en cours d'exécution, pour changer d'état, etc. Juste pour référence, un fragment du gâchis:
Ma question est de savoir s'il existe un ensemble standard ou nommé de meilleures pratiques (nommé en ce sens qu'il s'agit d'un ensemble de pratiques regroupées sous un nom spécifique) pour la documentation de produits plus complexes.
Quels sont les mots-clés que je devrais rechercher (les tentatives générales de «documenter les normes d'architecture logicielle» et les variations similaires conduisaient généralement à des logiciels pour les workflows ou la construction de systèmes CAO d'architecture).
Je m'attends également à ce qu'il n'y ait pas de meilleures pratiques générales pour les descriptions de haut niveau et que chacun construise sa propre philosophie.