コンテンツ統一方針(読者支援レイヤー優先)
背景
- book-formatter のテンプレートにより、レイアウト/ナビゲーション等の「表示体裁」はかなり統一できています。
- 一方で「コンテンツ構造・書き方」(章頭の学習目標、章末チェックリスト、読み方ガイド、安全性の注意書き、用語の扱い等)は書籍ごとに差分が残ります。
- すべてをテンプレートで固定すると各書籍の設計思想や事例選択を損ねるため、揃えるレイヤー / 揃えないレイヤー を明確化します。
本ドキュメントは、IT Engineer Knowledge Architecture 全体のコンテンツポリシーとしての基準です。 book-formatter 側の詳細ガイド(執筆観点/テンプレート観点)とも整合させます。
- book-formatter: https://github.com/itdojp/book-formatter/blob/main/docs/writing/BOOK-CONTENT-GUIDE.md
レイヤー別の統一方針
1) シリーズ横断で必ず揃える(MUST)
対象: 読者支援 / 安全性 / メタ情報
書籍レベル(各書籍の docs/index.md / docs/introduction/preface.md 等)
- 想定読者(職種、経験、前提知識)
- この本でできるようになること(3〜5項目)
- 読み方ガイド(読者セグメント別の推奨ルート)
章レベル(各章の index.md)
- 章冒頭に「この章の学習目標」(3〜5項目)
- 可能な範囲で章末に「まとめ」+ 簡易チェックリスト/演習
安全性・前提条件
- 危険な操作/設定/AI利用例には共通テンプレートの注意文を付与(検証環境、変更管理、情報セキュリティ/法令順守 等)
- 数値(導入率、速度向上、ベンチマーク等)には「執筆時点の一般的な参考値であり環境に依存する」旨を簡潔に明記
用語・略語
- 略語の初出で英語表記 + 1〜2行の日本語説明
- 用語集(glossary)を持つ場合は、本文と定義を統一(表記ゆれ防止)
2) 同種の書籍クラスタ内で揃える(SHOULD)
対象: ドメインごとの「書き方ガイド」
例
- Linux/インフラ系
- GitHub系
- AI×エンジニア思考・テスト系
- セキュリティ系
揃えたい内容の例
- 共通用語の定義(SLO/SLA、エラーバジェット、MTTR、Technical Debt 等)
- 抽象レイヤー図/パイプライン図の凡例・表記ルール
- ドメイン固有の前置き(SRE視点、アプリ開発視点、マネジメント視点 等)
このレイヤーはテンプレート強制ではなく、必要に応じて クラスタ別ガイド として整理し、各書籍の preface 等から参照します。
3) あえて揃えない(書籍の特徴として残す)
対象: 書籍ごとの個性/設計思想
- ストーリーライン・ケーススタディの選び方
- 章構成の細かい順序(導入重視/手を動かす優先 等)
- 抽象度の配分(思考法寄り vs 実装寄り)
- 図の構図・メタファーの選択
運用(推奨)
新規書籍
- book-formatter の starter テンプレートが提供する「想定読者/ゴール/読み方」枠を埋めて開始します。
- 各章
index.mdの「学習目標」を原則とします。
既存書籍
- 自動一括変換は行わず、改訂・増補のタイミングで段階的に寄せます。
- 優先順
- 書籍トップ/はじめにの「想定読者/ゴール/読み方ガイド」
- 各章の「学習目標」
- 安全性・前提条件(危険操作、AI利用、数値の前提)