Comment organiser des informations sur la solution du programme?

Question

Неllо. Je développe un système qui fonctionne avec la bourse (système, ci-dessous). Et il y a beaucoup d'informations dont mon programme a besoin pour interagir avec ce système. Ce système a une interface déclarée formelle, mais les différents détails à côté de cette déclaration et les exigences de mon système sont souvent modifiés. Alors, comment puis-je organiser les informations disponibles sur ce système et les exigences de mon programme qu'il pourrait être facile à comprendre et facile à changer.

Answer 1

Votre objectif premier est de créer la documentation pour les API pertinentes que votre programme expose, puis ajouter de la documentation pour les fichiers de configuration, peut-être même configurer un validateur pour la configuration. Le contenu généré automatiquement à partir des annotations de code (en fonction de votre solution, il peut s'agir des documents XML ou PHPdoc de .NET) est la première étape - cela vous aidera à documenter les classes et les interfaces pendant que vous travaillez sur le code. L'étape suivante consiste à documenter les éléments non codés. Si vous avez une configuration XML, vous pouvez écrire des schémas à valider, par exemple. Ensuite vient la documentation d'intégration - les étapes à suivre sur le serveur de production et/ou les postes de travail pour installer, mettre à jour et maintenir l'application, y compris les scripts de support.