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

Naopedia

筆者である naohito-T が、ITエンジニアとして役立つ Tips や、よく忘れがちな事項をまとめたナレッジベース
情報設計のフレームワークには Diátaxis(ディアタクシス) を採用。

注意

本ドキュメントの内容の正確性や最新性を保証するものではありません

Contact Information

Contact to naohito-T

ドキュメント構成

本サイトは Diataxis に基づき、次の 4 つの入口で構成しています。

  • tutorials: はじめて学ぶときの学習導線
  • how-to: 実務で目的を達成するための手順
  • concepts: 背景理解や設計意図
  • reference: 仕様・用語・辞書的情報

なぜ Diataxis なのか

Diátaxis はドキュメントを 4 分類に分けるフレームワークです。

  • Tutorials: 学習の道筋(導入)
  • How-to guides: 手順・やり方
  • Explanations/Concepts: 背景や考え方
  • Reference: 仕様・辞書的情報

このリポジトリでは、最終的に docs 配下を次の 4 つへ整理する方針です。

  • tutorials
  • how-to
  • concepts
  • reference

ドメインはディレクトリで表現し続けるのではなく、tags で横断できるように整備します。

また、resources や playbooks は独立 root としては持たず、次のように吸収します。

  • resources: 学習導線なら tutorials、資料集や辞書なら reference、背景理解なら concepts
  • playbooks: 運用手順やチェックリストとして how-to に吸収

この方式を選んだ理由は次の 3 点です。

利用者の行動に直結する

「知識の種類」ではなく「読者が今どういう目的で読むか」で分けるため、迷いにくい構造になります。
例として「AWS の VPC を調べたい」場合、目的別に Reference へ辿る方が、深いドメインツリーを辿るより見つけやすくなります。

パラレル軸(Domain × Purpose)

  • 物理構造は Diátaxis(目的軸)
  • ドメイン軸は tags で表現

この分離により、「構造はシンプル」「探索は横断的」を両立できます。

Diátaxis と C4 model (structurizr) で実現する継続的な開発ドキュメント改善プロセスの構築

Diátaxisに分類する場合、**「その知識を、自分が後からどういう目的(脳のモード)で引き出したいか」**によって配置がキレイに分かれます。

各分類の入口