Skip to main content

ページの設計と書き方 — 階層・ラベル・命名

ページの設計と書き方 — 階層・ラベル・命名

チームで長く使えるドキュメントにするための、ページ構成・命名・ラベルの設計指針です。

階層設計の原則

ページツリーは 浅く・広く より 深すぎない適度な階層 が読みやすいです。

Space ホーム
├── 01 はじめに（概要・用語）
├── 02 手順・ガイド
│     ├── セットアップ
│     └── 日常運用
└── 03 リファレンス
      ├── API
      └── 設定一覧
原則 説明
1 ページ 1 トピック 1 つのページに複数の無関係な話題を詰め込まない
親は「章」、子は「節」 親ページに概要、子ページに詳細
3〜4 階層以内 それ以上深いとサイドバーでたどりにくい

→ 作成手順: 「ページの作成と階層構造」（No.4.1）

命名規則

要素 推奨
タイトル 検索しやすい具体的な名（「API」より「ユーザー API リファレンス」）
接頭辞 番号や日付で並び順を固定（01-概要、2026-Q1-計画）
英数字スラッグ URL 共有時に読みやすい（タイトルから自動生成される）
ステータス Draft / 確定版はタイトルや Status ブロックで明示

同じ Space 内で 命名ルールをチームで統一 すると、検索とナビゲーションが楽になります。

ラベルの活用

ラベルはページを 横断的に分類 するタグです。

例: api、onboarding、deprecated、review-needed

→ 詳細: 「ラベルの付け方とラベルページ」（No.7.4）

コンテンツの書き方

要素 ヒント
見出し H1 はページタイトルのみ。本文は H2 から
Callout 注意・ヒント・警告を視覚的に区別
To-do 未完了タスクやレビュー項目
Synced block 複数ページで共通する定型文の再利用（No.4.5）
更新日 Date ブロックや最終更新者で鮮度を示す

Space との役割分担

単位 役割
Space チーム・プロジェクト・公開範囲の境界
ページ階層 Space 内のトピック整理
ラベル Space をまたぐ横断検索・分類

→ Space 設計: 「Space 設計のベストプラクティス」（No.5.6）

関連ナレッジ