あなたのWiki、迷路になってませんか?─Diátaxisではじめる情報整理
はじめに
最近、Diátaxis(ディアタクシス)というドキュメント設計フレームワークについて知る機会がありました。技術ドキュメントの整理に役立ちそうだったので、簡単に紹介します。
皆さんはこんな経験ありませんか?
- ドキュメントをどこに書けばよいか悩む
- 欲しい情報がどこにあるかわからず、探すのに苦労する
Diátaxisではドキュメントを「目的別」に整理します。書き手も読み手も迷わないようにする手助けになりそうです。
Diátaxisとは?
技術ドキュメントを体系的に整理するための構造化フレームワークです。ドキュメントを以下の4つのカテゴリに分類します。
カテゴリ | 目的 | 特徴 |
---|---|---|
Tutorial | 学習の導入 | 初心者向けのステップバイステップガイド |
How-to Guide | 特定の課題の解決 | 実践的で目的志向の手順書 |
Reference | 技術的な仕様や操作方法の提供 | 客観的で詳しい情報 |
Explanation | 背景や概念の理解を深める | なぜそうなるかを解説する文書 |
※Diátaxis より画像引用
2軸の説明はFoundationsのページに記載があります。
-
縦軸
- Action: 実践的な知識。「どうやるか」を知っていて、実際に行うこと
- Cognition: 理論的な知識。「なぜそうするか」を理解していること
- → 両者は密接に結びついているが、異なる側面として存在する
-
横軸
- Acquisition:スキルや知識を学び、身につけるプロセス(=「学び」)
- Application: 身につけたものを実際の場面で活用するプロセス(=「実践」)
- → こちらも対になる関係で、両方が必要とされる
書き手・読み手の迷いを減らすために
ドキュメントを書くときに、次のような迷いが生じることはないでしょうか?
- これは「手順書」なのか「解説」なのか?
- 初心者向けに書くべき? 上級者向け?
- どこに、どのカテゴリで書けばよいのか?
こうした悩みの多くは、「ドキュメントの目的が曖昧」であることに起因します。
Diátaxisの4分類に沿えば、書き手も「何を書くべきか」「どんな構成にするべきか」が明確になり、読み手も「どこに何が書いてあるか」を理解しやすくなります。
読み手の目的に応じた文書タイプ
読み手の気持ち | 対応するタイプ | 主な用途 |
---|---|---|
「まず試したい」 | Tutorial | 初心者が一歩目を踏み出すための案内 |
「どうやるの?」 | How-to Guide | 特定のタスクを実行するための手順書 |
「〇〇って何?」 | Reference | 用語・仕様などの網羅的な参照情報 |
「なぜそうなるの?」 | Explanation | 背景や選定理由、設計思想などの解説 |
書き手にとっての判断軸
では、書き手はどう判断すればよいのでしょうか?
文書を書く前に、以下のような問いを立てると分類しやすくなります。
- これは「やり方」を教えたい? → How-to Guide
- 何かを学んで身につけてほしい? → Tutorial
- データや仕様をまとめておきたい? → Reference
- なぜそうしたか、背景を共有したい? → Explanation
このように目的に応じて分類すれば、構成も自然に決まり「どこに何を書けばいいか」という迷いが減っていきます。
読み手にとっても嬉しい構造
読み手にとっても、目的別に文書が整理されていれば、
- 手順だけ欲しいときに、長い背景説明を読まずに済む
- 逆に「なぜこうなっているのか」を深く知りたいときに、迷わずたどり着ける
といったメリットがあります。書き手の迷いを減らすことは、そのまま読み手のストレスを減らすことにもつながり、チーム全体でナレッジの整理がしやすくなりそうです。
ナレッジツールでのDiátaxis活用例
多くのナレッジ共有ツールは、階層構造やページテンプレートなどを備えており、Diátaxisとの相性が良いのではないかと感じます。たとえば以下のように、目的別に分類することで、書き手の迷いを減らし、読み手が求める情報に素早くたどり着けるようになります。
プロダクトA
├── Tutorials(例:セットアップ手順)
├── How-to Guides(例:ログイン機能のカスタマイズ方法)
├── Reference(例:API仕様一覧)
└── Explanation(例:認証方式の選定理由)
ツールの例として、ConfluenceのようなWiki型ナレッジベースがあります。階層構造やテンプレート機能を活用することで、チーム全体で書き方や分類方針を共有しやすくなるのではないでしょうか。
さらに、各カテゴリにテンプレートを用意しておけば、ドキュメント作成のハードルを下げることができます。「書く文化」を育てる土台にもなります。
AI時代における情報整理
生成AIの登場により、ユーザーはドキュメントを直接読むのではなく、AIツールを介して情報にアクセスする機会が増えています。どこに何が書かれているかを意識する必要がなくなり、情報構造そのものはユーザーの目に触れにくくなっています。
とはいえ、AIが適切な情報を引き出すためには、元のドキュメントが整理・構造化されていることが効果的です。構造が整っていれば、AIもより正確に情報を取り出せます。
そうした意味で、Diátaxisのような情報整理の枠組みは、AI時代においても有効なのではないでしょうか。
Diátaxisを活かす運用アイデア
Diátaxisの考え方は、ページ構成だけでなく、検索性や整理の工夫にも応用できます。
文書タイプをタイトルや見出しに添える
可能であれば、文書タイプ(How-to、Referenceなど)をタイトルやサブタイトルに含めることで、検索結果一覧や一覧表示で文書の性質がわかりやすくなります。
例: How-to: ログイン機能のカスタマイズ
ページタイトルへの直接記載が難しい場合は、ページ冒頭に記載するだけでも効果があります。
タグやラベルで分類を補足
ナレッジ共有ツールにタグ機能やラベル機能がある場合は、それを活用して分類を補強できます
例: tutorial
, how-to
, reference
, explanation
タグを活用することで、検索性やフィルタリング性が高まり、情報の発見がしやすくなります。
生成AI活用時のポイント
生成AIを使ってドキュメントを書く場面でも、Diátaxisの分類を意識することで、出力の構造化が可能になります。
とはいえ、すべてがきれいに分類できるわけではありません。複数のタイプが混在する場合は、人間が判断して再構成する必要があります。
Diátaxisで「文化」を変える
チームでこのような悩みを抱えていませんか?
- 「誰もドキュメントを書きたがらない」
- 「書いても読まれない」
- 「どこに何を書くべきかが曖昧」
- 「情報が属人化していて、引き継ぎが地獄」
これらはツールの問題ではなく、文化の問題とも言えます。Diátaxisは「目的」を明確にすることで、書くことの意味と価値を再定義してくれます。
「書くこと=貢献」になる
- How-toやReferenceは、他者の課題解決に直結
- Explanationは、設計思想や判断理由を共有
- 「役に立った」と言われることで、書くモチベーションが向上
レビューや引き継ぎの効率化
- 粒度や目的が明確になり、レビューの質が向上
- 引き継ぎがスムーズになり、チームの生産性が向上
ナレッジが資産になる
- 属人化していた情報が、構造化された知識として蓄積
- オンボーディングがスムーズに
- 「誰かが困ったときに、すでに答えがある」状態を作れる
おわりに
ドキュメントは読まれてこそ価値があります。いくらドキュメントを拡充しても、利用する人がいないのでは報われませんよね。目的を明確にすることを心掛けていきたいです。
もちろん、すべてのドキュメントに細かな分類が必要というわけではありません。シンプルな内容にはシンプルな記述で十分なこともあります。一方で、情報が複雑化しやすい内容や長期的な運用を見据えるなら、Diátaxisの枠組みは強力な手助けになります。
ただし、Diátaxisは万能ではありません。厳密に適用しようとすると、かえって摩擦を生むこともあります。目的は「分類」ではなく「伝わること」。その点を見失わずに、柔軟に取り入れる姿勢が重要なのではないでしょうか。
- 各人が自力でキャッチアップできるようになる
- ドキュメントを書くことが「チーム貢献」として認識される
- ドキュメントの閲覧数が増える
- 「どこに書くべきか」の議論が減る
Diátaxisは、これらの成果を生み出すことができると感じました。
「完璧を目指すのではなく、今よりちょっとわかりやすくする」そんな意識が、チームに良い文化を根づかせる一歩になるはずです。
Discussion