トピック
トピックは、独立した論理的な情報単位を表すことを目的としており、この情報は個別に作成、保存、管理、配布、再利用できます。 トピックにはさまざまな種類があります。これは、記述可能な内容とコンテンツの記述方法に直接影響します。
トピックの対象
一般的に、トピックにはタイトルを付け、独立して理解でき、複数のコンテキストで使用できる情報を含める必要があります。1 つの主題に対応する、あるいは 1 つの問いに答える程度に短いが、それ自体で意味を成すほどには長く、自己完結型ユニットとして作成されます。とはいえ、トピックにはタイトルのみを含めることもでき、目次内の他のサブトピックをグループ化するなど、パブリケーション全体の特定の機能のために使用できます。
標準タイプ
- コンセプト: コンセプト トピックとは、物事がどのように一般的に機能するかを説明するものです。これらのトピックには、コンテンツの理論上の側面が含まれています。コンセプトは柔軟性があり、テーブル、画像、リストなどが使用できます。コンセプト内のセクションを使用してコンテンツを構造化できます。ただし、使用できるセクションのレベルは 1 つだけです (セクションにセクションを含めることはできません)。
- タスク: タスク トピックでは、手順とアクションを説明します。これらのトピックは一般にコンセプト トピックに続いて、コンテンツの実用的な側面を説明します。タスクは、最も制約のあるトピックのタイプの 1 つです。アクション ステップのみをリストでき、オプションでステップの選択と結果をリストすることもできます。トピックの開始時にコンテキスト プレゼンテーションを行うことも、前提条件リストを使用することもできます。
テクニカル ドキュメントは、通常、ユーザーがアクションを実行する方法に関するものであるため、タスク トピックはドキュメントのバックボーンになる傾向があります。
- 参照: 参照トピックでは、参照する項目の完全なリストを提供します。これらのトピックは、コンテンツの辞書の部分であり、用語のリストと定義、エラー コードの表、互換性のあるソフトウェアのリストなどです。参照は柔軟なトピックで、テーブル、リスト、およびセクションや「定義リスト」構造などの分割構造を使用して、コンテンツを自由に構造化できます。ただし、1 つの構造を使用し始めた場合、トピック全体で使用し続ける必要があります。
これらの標準タイプは、特殊な標準トピック タイプまたはカスタム トピック タイプにさらに特化できます。
カスタム タイプ
各組織は、独自の特定のタイプのトピックを作成したり、内部構造を決定するテンプレートを作成したり、トピックで使用する必須エレメントを作成したりすることができます。
- トピックで一部のエレメントを必須または禁止にするスタイル シート。
- 特定のエレメントを含むトピックを作成するテンプレート。
たとえば、新しいトピックに段落、図、表を入力するテンプレートを定義し、他のエレメントを禁止することができます。この場合、ライターはコンテンツを許可された形式に適合させる必要があり、この場合、セクション、タスク ステップ、または新しいトピックにすでに含まれているエレメント以外のエレメントを作成することはできません。もちろん、スタイル シートやテンプレートはさらに柔軟にすることもできます。
このため、トピックを作成するときに、追加するコンテンツのタイプに応じて選択するトピックの種類を把握する必要があります。トピックを作成して記述を開始した後で、コンテンツがタイプと一致しないとわかった場合は、このトピックを削除して、正しいタイプの新しいトピックを作成する以外の解決策はありません。
トピックのタイトル
トピック オブジェクトの場合、Title プロパティは、パブリッシュされた出力に表示されるタイトルに関連しますが、このタイトルとは異なります。パブリッシュされたタイトルは、プロパティの値ではなく、トピック コンテンツの title エレメントから取得されます。新しいトピックを最初に作成するときは、入力した Title プロパティもトピック コンテンツのタイトルとして使用されますが、その時点からは関連付けられず、Title プロパティとトピックのタイトルは異なる場合があります。関連付けないことによって、リポジトリ内のトピックをより効率的に管理できます。