Skip to main content

Naopedia

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

caution

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

Contact Information

Contact to naohito-T
  1. なぜ Diátaxis なのか

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

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

選んだ理由は

🔹 利用者の行動に直結する

「知識の種類」ではなく「読者が今どういう目的で読むか」で分けるので、ユーザーが迷子になりにくい。 → あなたの大規模ツリーだと「AWSのVPCを調べたいとき」に infrastructure/cloud/aws/vpc を掘るより、「Reference/AWS/VPC」で一発で見つけやすい。

🔹 重複を防ぎやすい • 同じAWS VPCでも、「概念説明」「構築手順」「APIリファレンス」「チュートリアル」をバラして置ける。 • 今のツリーだと「infrastructure」と「development/web/performance」と「security」で似たことが書かれて重複しがち。

🔹 運用ルールに落とし込みやすい • PR時に「この文書は concept? how-to?」とラベル付け強制できる。 • フォルダは4〜6個だけに収束 → ルートがすっきりする。

パラレル軸(Domain × Purpose) • 物理的には Diátaxis に置き、タグでドメインを表す。 • 「構造はシンプル」「タグで横断検索」ができる。 • 今の規模感にはこれがベストマッチ。

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