リファレンス・トピックの役割

リファレンス・トピックは、ユーザーがタスクを完了するのに必要な、特定の事実情報を提供する役割を担います。

各リファレンス・トピックは、構文、パラメーター、サンプル・コードといった、特定種類の情報を一貫して提供します。リファレンス・トピック群は、定められたルール(例えば、アルファベット順や機能別)に従って、整列されます。通常、リファレンス・トピックがリニアな階層構造で書かれることはありません。

リファレンス・トピックで書かれた情報の意味や、その情報をどう使うのかといった説明は、コンセプト・トピックやタスク・トピックに書きます。リファレンス・トピックは、単に、構文、パラメータ、仕様などの情報に素早くアクセスするための手段を提供します。

以下のような情報は、リファレンス・トピックを使って記述するのに適しています。