文書化テンプレート

作成される文書はすべて文書化テンプレートに従います。アプリでは文書化テンプレートと呼ばれます。テンプレートでは、文書に含める項目とその順序を設定します。表紙、目次、章とセクション、テキストブロック、文書化フィールド、モデル、RACIマトリックス、要素の文書化、グラフ、アクティビティごとのRACI割り当てを指定できます。

アーキテクチャレベルごとにテンプレートを設定できます。同じプロセスでも、概要版、詳細な標準作業手順書、監査用資料など、用途に応じて異なる形式で記載できます。

テンプレートの場所

• 設定 → プロセスアーキテクチャでは、各レベルがカードで表示されます。レベルの文書化テンプレートのラベルまたは編集アイコンを開くと、エディターが表示されます。
• 文書化タブでは、サイドバーの文書化テンプレートセレクターで表示する文書を切り替えます。別のテンプレートを選ぶまでは、そのレベルの既定のテンプレートが使われます。
• 編集者は、文書からテンプレートを直接開くこともできます。エクスポートメニューを開き、**テンプレートを編集…**を選択します。

テンプレートはプロセスアーキテクチャで設定します。プロセスの文書化を閲覧できるユーザーには、テンプレートに基づく文書が表示されます。エクスポートには、文書化ページで選択されているテンプレートが使われます。

テンプレートの選択と管理

エディターは1つのダイアログで構成されています。上部にテンプレートセレクターと追加ボタン、左側に文書ツリー、右側に選択したノードの設定があります。フッターにはキャンセルと保存があります。

エディターを開くと、そのレベルで最後に編集したテンプレートが表示されます。文書化ページの**テンプレートを編集…**を選択すると、現在の文書で使われているテンプレートが開きます。

• 文書化テンプレートセレクターでは、そのレベルのテンプレートを切り替えられます。下書きのテンプレートは閲覧者には表示されません。既定は、文書化ページを開いたときに使われるテンプレートを示します。
• **+**をクリックすると、新しい文書化テンプレートという名前のテンプレートが追加され、選択されます。
• 名前を選ぶと、選択中のテンプレートの名前を変更できます。
• 公開済みでは、閲覧者が文書化ページでテンプレートを選択できるかどうかを設定します。編集者には下書きも表示されます。
• 既定に設定を選ぶと、別のテンプレートが選択されていない場合に文書化ページで使われるテンプレートになります。既定のテンプレートは各レベルに1つ設定できます。
• 文書化テンプレートを削除を選ぶと、選択したテンプレートが削除されます。レベルにある唯一の既定テンプレートは削除できません。先に別のテンプレートを既定に設定してください。
• 文書化されていない要素を含めるをオンにすると、説明がまだないモデル要素も文書の要素セクションに追加されます。文書化が完了した要素だけを掲載する場合は、オフにします。

テンプレートの追加と削除、既定テンプレートの設定はすぐに反映されます。名前、表示設定、含める内容の切り替え、表紙、文書ツリーは保存をクリックして保存します。

文書の構成

エディターの左側に文書ツリーが表示されます。ノードをドラッグすると順序を変更できます。章またはセクションにドロップすると、その中に配置されます。行のメニューボタンを使うか、行を右クリックして内容を追加・削除します。

章とセクション

• 下に章を追加を選ぶと、文書の最上位に章が追加されます。
• セクションを追加または下にセクションを追加を選ぶと、下位または同じ階層にセクションが追加されます。
• 章またはセクションを選択すると、タイトルを編集し、自動番号のオン・オフを切り替えられます。番号はツリーの階層に従います。章はX、章内のセクションはX.Y、さらに下位のセクションはX.Y.Zです。パネルには、ノードが表示される見出しレベルが示されます。
• 削除を選ぶと、選択したノードとその子ノードが削除されます。

コンテンツノード

ノードメニューから次の操作を選べます。

• テキストを追加／下にテキストを追加を選ぶと、Markdownブロックが追加されます。Markdownテキスト欄に見出し、リスト、リンク、メモを入力できます。プレースホルダーも使用できます。
• 文書化フィールドを追加…／**下に文書化フィールドを追加…**を選ぶと、そのレベルで公開されている文書化フィールドが追加されます。後から非公開になったフィールドは文書から除外されるため、そのレベルで公開されなくなった内容が文書に表示されることはありません。
• モデルを追加／下にモデルを追加を選ぶと、プロセス図が表示されます。データを表示を選ぶと、図の下に「使用したフィルターとデータ」の概要が追加されます。
• RACIを追加／下にRACIを追加を選ぶと、RACIマトリックスが表示されます。
• 要素を追加／下に要素を追加を選ぶと、すべてのモデル要素の文書化が表示されます。
• グラフセクションを追加を選ぶと、文書内の指定した位置にグラフの文書化が配置されます。最上位にも、章やセクションの中にも追加できます。
• アクティビティごとのRACIを追加を選ぶと、要素セクションの各アクティビティにRACIの割り当てが追加されます。最上位に追加すると、文書全体に適用されます。

表紙を追加と目次を追加は、文書の最上位でそれぞれ1つだけ追加できます。どちらもノードとして追加されます。選択して編集するか、表紙や目次が不要な場合は削除してください。

表紙

表紙ノードを選択して、次の項目を設定します。

• 背景画像をアップロード、置換、または削除アイコンで削除します。
• タイトルは、既定でプロセス名が設定されます。プロセスに応じてタイトルを変えるには、プレースホルダーを使います。
• サブタイトルには、バージョン、分類、対象者などを記載できます。

プレースホルダー

編集可能なテキストでは、文書の表示時にProcessMindが値を挿入するプレースホルダーを使用できます。

{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}

プレースホルダーのチップをクリックするとコピーでき、ダブルクリックすると編集中のテキストに追加できます。プロセスに値が設定されていないプレースホルダーは、空のテキストとして表示されます。

テンプレートとエクスポート

テンプレートによって文書の内容が決まります。PDF、Word、Markdownへのエクスポートと印刷には、選択したテンプレートが適用されます。テンプレートに含まれない内容はエクスポートされません。特定のテンプレートで項目を非表示にするには、そのノードを削除します。1つのプロセスレベルで複数の文書形式を使う場合は、形式ごとにテンプレートを作成し、文書化ページを開いたときに使うテンプレートを既定に設定します。

関連トピック

• 文書化エディター
• 文書化のエクスポート
• プロセスアーキテクチャ
• アーキテクチャレベル