カスタムドキュメントの編集と更新

<< 目次を表示 >>

ページ位置:  ドキュメントの生成 > カスタムドキュメント >

カスタムドキュメントの編集と更新

カスタムドキュメントは動的なドキュメントであり、適切な権限を持つ設計者は、いつでもドキュメント内の内容を編集することができます。

 

 

これらの項目の詳細は後述します。

 

ドキュメントに追加された動的な内容を右クリックしてコンテキストメニューを呼び出すことができます。「ドキュメントを更新」を選択することで、動的に追加した内容の全てをまとめて更新することができます。また、右クリックメニューからは切り取り・貼り付けなど、一般的な操作に関する機能を呼び出すこともできます。

 

 

テンプレートの変更

この機能は、ステークホルダーからの要望に対応してドキュメントの内容を調整する場合に便利です。たとえば、元々要求に関するテンプレートを使用していて、各要求を段落形式で一覧表示し、その名前の下に詳細を表示していたとします。ステークホルダーは、文書を確認した後、表形式で一覧表示された形で見たいと思うかもしれません。この場合は、別のテンプレートを使用する必要があるため、この機能を使用して、別のテンプレートに切り替えます。

 

 

生成範囲を選択

カスタム ドキュメント内の内容が多くなり、固定の内容と動的な内容が混在すると、どのセクションが動的に追加され、どのセクションが固定なのかがわからなくなることがあります。この機能を使用すると、左側のパネルのラベルから、追加された各項目ムのカスタム ドキュメント内の描画範囲を把握することができます。

 

 

生成範囲を更新

ユーザーがモデルブラウザからカスタム ドキュメントに項目をドラッグ&ドロップすることで、モデルから内容を追加できますが、最初にドロップした時点での内容となります。ドキュメントに追加された項目が更新されでも、カスタム ドキュメントの内容は自動的には更新されません。この機能を使用すると、カスタムドキュメント内容を最新の状態にすることができます。

 

 

モデルブラウザ内の位置を表示

ドキュメントが作成され、新しい内容が追加され、指定したテンプレートによってドキュメントが生成されると、それぞれの内容に対応する項目がモデルブラウザ内のどこにあるかがわからないかもしれません。この機能を使用すると、追加された項目がパッケージ・ダイアグラム・要素・属性・操作・受信のいずれであるかに関係なく、モデルブラウザ内の位置にカーソルを移動します。

 

 

生成範囲を削除

ドキュメントに追加されたセクションが、何らかの理由で不要になることもあります。この機能を使用すると、固定の内容か動的な内容かにかかわらず、他のセクションを変更せずにドキュメントからそのセクションを削除することができます。動的な内容であれば、必要であれば、いつでもそのセクションを再び追加することができます。

 

 

内容の編集

動的な内容として追加し、テンプレートで生成された結果について、固定の内容に変換する機能はありません。

 

内容の位置を変更する場合には、対象の範囲を選択して右クリックメニューから「切り取り」を実行し、希望する位置で「貼り付け」を実行してください。対象の範囲に動的な内容が含まれる場合、左側の一覧でも、移動先の位置に応じた順序に一覧内の項目が移動します。

 

「生成範囲を選択」の機能は、以下の目的でも使えます。

 

左側の一覧の項目を右クリックし、「生成範囲を選択」を実行すると、関連する範囲が選択状態になります。必要に応じて、この選択状態になった範囲を含めて、移動したい範囲を選択してください。

 

固定の文字列として見出しを追加するような場合には、この「生成範囲を選択」を実行すると、自動生成される範囲が明確になりますので、その前に見出しとなる文字列を追加してください。