documentation - プログラム ソリューションに関する情報をどのように整理しますか?

Question

ああ。証券取引所と連携するシステム（システム、以下）を開発しています。そして、私のプログラムがこのシステムとやり取りするために必要な情報がたくさんあります。このシステムには正式に宣言されたインターフェースがありますが、この宣言以外のさまざまな詳細と私のシステムに対する要件は頻繁に変更されます。では、このシステムに関する入手可能な情報と、プログラムに対する要件を理解しやすく変更しやすいものにするにはどうすればよいでしょうか。

Answer 1

あなたの最初で最も重要な目標は、プログラムが公開する関連 API のドキュメントを作成し、構成ファイルのドキュメントを追加することです。おそらく、その構成用のバリデーターをセットアップすることさえあります。

コード注釈 (ソリューションによっては、.NET の XML ドキュメントまたは PHPdoc など) からコンテンツを自動的に生成することが最初のステップです。これは、コードで作業するときにクラスとインターフェイスを文書化するのに役立ちます。次のステップは、コード以外の資産を文書化することです。XML 構成がある場合は、たとえば、検証するスキーマを作成できます。

その後、統合ドキュメントが提供されます。これは、サポート スクリプトを含め、アプリケーションをインストール、アップグレード、および維持するために、運用サーバーやワークステーションで実行する必要がある手順です。