1

私は、複雑な既存システムの文書化に参加するよう求められました (当然、既存の文書はありません)。

キャプチャする関連詳細は次のとおりです。

  • ホスト名、IP アドレス、およびネットワーク
  • クラスターの構成
  • ソフトウェア パッケージの名前
  • 構成ファイルのパス
  • 主要な設定値
  • 異なるホストとそれらのホスト上のサービス間の相互作用のシーケンス
  • 異なるコンポーネント間で渡される情報
  • システムとサブシステムの所有権

標準化されたアプローチ、または少なくともいくつかのベスト プラクティスを使用したいので、UML 配置図やコンポーネント図などの使用を検討していますが、UML は初めてなので、どちらが最適かわかりません。すべてをキャプチャできる 1 つのタイプの図を使用したいのですが、そうでない場合はできるだけ少なくします。

関連情報の一部が図に収まらない可能性があると思います。その場合、どのタイプのドキュメントに詳細が含まれているのか疑問に思っています。

何を生産すればよいですか？

4

1 に答える 1

0

同じ図にあまりにも多くの懸念事項を詰め込むと、読者を混乱させるでしょう。より良いアプローチは、複数の図 (および関連するテキストと表) を使用することです。

少なくとも、次のことをお勧めします。

  • コンポーネントが実行時にどのように相互作用するかを説明するビューと、それらを接続するインターフェースの説明。これは、各コンポーネントの責任の説明に最もよく関連付けられています。
  • コンポーネントのデプロイ方法を説明するビュー。
  • さまざまなモジュールがどのように構築されるかを説明するビュー。

さまざまなタイプの UML ダイアグラムを、それぞれの目的に使用できます。個人的には、画像や色を使ったアドホックな図に頼る傾向があります。UML ダイアグラムは退屈すぎると思います。もちろん、カスタム ダイアグラムを使用する場合は、常にキー ボックスまたは凡例ボックスを提供することが重要です。

于 2012-11-30T14:46:49.127 に答える