ベストアンサー
UML(最も広く使用されている図)を使用して作成する場合ソフトウェアアーキテクチャ、ビジュアルパラダイム Community Edition は、完全に無料のソリューションです(個人用および非個人用) -商用)。
UML 2.5ダイアグラムをサポート(シーケンスダイアグラムを使用したMVCフレームワークソフトウェアアーキテクチャ)
Model–view–controller ( MVC )は、アプリケーションを3つの相互接続された部分(モデル/ビューとコントローラー)に分割するユーザーインターフェイスを開発するために最も広く使用されているソフトウェアアーキテクチャフレームワークの1つです。これは、情報の内部表現を、情報がユーザーに提示され、ユーザーから受け入れられる方法から分離するために行われます。
MVCアーキテクチャは、これらの主要コンポーネントを分離し、次の概念を使用して効率的なコードの再利用と並列開発を可能にします。 Webアプリケーションとデスクトップアプリケーションの両方に適した関心の分離。
例: JHispter は、(REST APIと共に)MVCフレームワークです。 Webアプリケーションは、最も人気のあるフレームワークSpring もすべての種類のアプリケーションのMVCに属しています。
UMLでは、シーケンスを使用できますMVCソフトウェアアーキテクチャを表す図。 (出典:ビジュアルパラダイム– MVCフレームワーク-ビジュアルパラダイムコミュニティサークル)
- エンティティは、システムデータ(顧客、製品、トランザクション、カートなど)を表すオブジェクトです。
- 境界は、システムアクター(UserInterface、DataBaseGateway、ServerProxyなど)とインターフェイスするオブジェクトです。
- コントロールは、境界とエンティティの間を仲介するオブジェクトです。
コマンドの実行を調整します。エンティティおよび境界オブジェクトと相互作用することによって境界から来る。コントロールは多くの場合、ユースケースシナリオに対応し、シーケンス図で表されることがよくあります。
MVCシーケンス図のライフラインにステレオタイプを使用できます。 MVCで使用しているオブジェクトのタイプを視覚的に明確にするため
無料のUMLツールを使用してMVCシーケンス図を作成するには
UML図の詳細を理解する
シーケンス図の詳細
回答
アーキテクチャ(またはさらに詳細な低レベルの設計)を文書化するときに私が一般的に採用する高レベルのアプローチは次のとおりです。
- 設計の利害関係者を特定します。エンジニアリング/開発チームは1つの利害関係者です。テスト/品質保証チーム、ITインフラストラクチャチーム、プロジェクト管理、および場合によってはサポートスタッフも、システムの利害関係者であり、設計のさまざまな側面に関心を持っている可能性があります。
- システムの関心領域を特定します。システムにデータベースがある場合、1つの視点はデータベース構造です。分散システムを使用している場合は、システム管理者またはカスタマーサービススタッフがコンポーネントのインストール場所に関心を持つ可能性があります。パブリックインターフェイスがある場合、外部開発者はそのインターフェイスが何であるか(ファイル形式、データ形式など)に関心があります。複雑なアルゴリズムが多数ある場合、アルゴリズムの設計者/保守担当者はワークフローとアルゴリズムの手順に関心があります。識別した各視点は、特定の懸念事項です。
- 持っている視点ごとに、適切な表現を選択します。データベースの観点からは、実体関連図とデータディクショナリが役立つ場合があります。パブリックインターフェイスの場合、XMLスキーマドキュメントまたはAPIドキュメントをドキュメントの一部として含めることができます。複雑なアルゴリズムの場合は、UMLアクティビティまたは相互作用の概要図を検討してください。表記法を選択するときは、よく知られた明確な表記法を好むので、他の人に自分の表記法を説明する必要はなく、使用されている記号がわからない場合は、既存の参考資料を参照するだけで済みます。
- 図の周りにテキストによる説明と合理的な説明を追加します。あなたが下したアーキテクチャ上の決定が何であったかだけでなく、それらの決定を下した理由を説明してください。
ザックマンフレームワーク、オープングループアーキテクチャフレームワーク、米国防省仕組フレームワークなどのアーキテクチャフレームワークDefense Architectural Framework、およびその他のアーキテクチャフレームワークは、一般的に適用可能な重要な視点とビューを定義するのに役立ちます。
最終的に、「最良の」ドキュメントは、利害関係者のニーズを満たすドキュメントです。誰が情報を必要とし、何が正確に必要かを特定することが最初のステップです。