プログラムソリューションに関する情報を整理する方法は？

Question

Неllо。私は証券取引所で働くシステムを開発しています（下記、システム）。私のプログラムがこのシステムとやりとりするために必要な多くの情報があります。このシステムは公式に宣言されたインターフェースを持っていますが、この宣言のほかに私のシステムに対する要件はしばしば変更されます。では、このシステムと要件に関する利用可能な情報を自分のプログラムにどのように整理すれば、わかりやすく簡単に変更できます。

Answer 1

あなたが最初に目指している目標は、プログラムが公開する関連APIのドキュメントを作成し、設定ファイルのドキュメントを追加することです。設定用のバリデーターを設定することさえできます。

コードアノテーションから自動的に生成されたコンテンツ（ソリューションに応じて、.NETのXMLドキュメントやPHPdocなど）が最初のステップです。これは、コードの作業中にクラスとインターフェイスをドキュメント化するのに役立ちます。次のステップは、非コードアセットを文書化することです。 XML構成を使用している場合は、たとえば、検証するスキーマを記述できます。

その後、インテグレーションドキュメント - サポートスクリプトを含む、アプリケーションのインストール、アップグレード、およびメンテナンスのために本番サーバーやワークステーションで実行する必要がある手順が記載されています。