メインコンテンツまでスキップ

Reference

このセクションは、正確な情報をすばやく参照するための辞書です。

目的

  • 必要な仕様を短時間で確認する
  • 記述の一貫性を保つ基準を提供する
  • 実装時の参照元を一本化する

含める内容

  • API や設定項目の一覧
  • 用語集、パラメータ定義、コマンド早見表
  • バージョンや制約条件などの事実情報

含めない内容

  • 手順中心の実践ガイド(how-to)
  • 背景理解を目的とした解説(concepts)
  • 入門者向けの学習導線(tutorials)

次に読む

  • How-to: 参照情報を使って作業する
  • Concepts: 仕様の背景を理解する
  • Tutorials: 基礎から学習する