アプリケーションのさまざまなプロセス フローを文書化する良い方法はありますか?[閉まっている]

Question

ASP.NET MVC アプリケーションのさまざまなプロセスと依存関係を視覚的に示す、シンプルな中央ドキュメントを作成したいと考えています。たとえば、「Signup」アクション メソッドが POST データを取得するときにサービスがどのように呼び出され、復号化と検証が行われ、最後にどのように行われるかなどです。すべてはリポジトリを使用して保存され、電子メール サービスが電子メールを送信します。メソッド呼び出し、インスタンス名、パラメーターを示すフローチャートだけでも、最初から最後まで (分岐あり) あれば優れています。

これを自動的に行うことができるものはありますか(例:それとも、手動で行うか、特定のツールを使用しますか?その重要な点は、新しい開発者が、物事がどのように機能するかをソース内で際限なく「定義に移動」参照することなく、アプリケーションにどのような種類の依存関係やフローが存在するかをすぐに理解できるようにすることです。

ありがとう

Answer 1

を使用しております Altova UModel (すべての図は UML で記述されています)。私は Visio よりもこれを好みますが、Visio は合理的な代替手段です。あなたはいくつかの異なるタイプの図について話していますが、 アクティビティ図 そして シーケンス図. 。他にも役立つのは、 データフロー図. 。これらのドキュメントの正しいセットがあれば、新しい開発者が最新情報を理解するのがはるかに簡単になります。もちろん、場合によっては、最初に UML に慣れてもらう必要があります (ただし、UML を読むことは、適切な UML を書くことよりはるかに簡単です)。

彼らのページより（強調追加）...

視覚的にアプリケーションモデルを設計し、Java、C＃、またはVB.NETコードとプロジェクトのドキュメントを生成します。 または、既存のプログラムをUML 2図にリバースエンジニアリングします次に、デザインを微調整し、コードを再生して往復を完了します。

Answer 2

個人的に私は、モデリングのこのタイプのエンタープライズアーキテクトを使用します。それは自動的にあなたの静的ソースコード情報だけでなく、実行時の動作の両方を分析することで、特定の関係を構築することができます。しかし、私は個人的にそのように使用していない...私は最初にシステムをモデル化し、多くの場合、モデルからコード生成の良い取引で（そのモデルに基づいたシステムを構築します。