ドキュメントの種類
このサイトのドキュメントは、reference、usage、runbookの3種類に分けます。
ほとんどのドキュメントはリファレンス(reference)です。システムやサイトの基本事項、概念、構成などを説明します。usageやrunbookに当てはまらない一般的なドキュメントは、すべてここに含めます。
使い方(usage)は、現在の仕様・設定・制約を確認するページ、または一つの目的を達成するための使い方を記載するページです。
ランブック(runbook)は、判断・前提・完了条件を含めて、一つの作業を開始から完了まで進める手順です。
usageとrunbookは、referenceの例外として扱います。文書は分類ごとではなく、内容のドメインに沿って置きます。