UX Core Specification v1
目的
- シリーズ内書籍の見た目と導線を「共通コア」で統一し、ばらつきを最小化する
- 差分は
profileとmodulesで吸収し、強制ではなく段階適用を可能にする
適用範囲
- 新規書籍: book-formatter から生成する標準フォーマット
- 既存書籍: 破壊的変更を避け、まずは共通コア(ヘッダー/サイドバー/フッター等)を適用する
用語
- 共通コア: 全書籍で必須とする UI 骨格と導線
- プロファイル: 書籍の目的別に定義する A/B/C の類型
- モジュール: profile に応じて ON/OFF 可能な UI 部品
共通コアの要件
Must(必須)
- ヘッダー: 書籍タイトル、トップへの導線
- サイドバー(または同等のグローバルナビ): 章/付録への導線
- フッター: ライセンス表記(CC BY-NC-SA 4.0、商用は別契約)、リポジトリ導線
- 全ページで共通のテーマ/検索導線(既存の実装に追随)
- トップページの必須スロットを保持(標準スロットを参照)
- 章ページの必須スロットを保持
Should(推奨)
- トップページの見出し名称を標準スロットに合わせる
- 章ページに「目的(objectives)」がある場合は章冒頭に表示する
- 付録/用語集/図表一覧などの導線を明示する
May(任意)
- プロファイルに応じた modules を追加する
- 既存書籍の制約によりスロットの順序を微調整する
UI骨格(スロット定義)
トップページ標準スロット(index)
hero: タイトル / サブタイトル / 学習成果(3項目)readerProfile: 想定読者 / 前提知識 / 所要時間readingGuide: 読み方ガイド(module)toc: 目次(自動生成)license: ライセンス表記
注記:
readerProfileは「想定読者」「前提知識」「所要時間」を別見出しで分割してもよいreadingGuideは modules の ON/OFF に従い表示される
章ページ(chapter)
objectives: 章の目的(front matter)body: 本文summary: まとめnextSteps: 次に読む内容や関連章
付録/巻末
appendicesに modules(glossary / figureIndex / legalNotice 等)を配置可能
互換性方針
ux未指定の既存書籍は、現行挙動を維持する- 段階適用時は共通コアの適用を最優先し、本文構造は変更しない