Skip to content

Diagrams

Source: View on GitHub / Propose an edit

このディレクトリには、World Foundation Designの構造、モジュール関係、ガバナンスフロー、移行ロードマップなどを説明する図表を置きます。

図表は、設計文書、モジュール、運用記録、調査への参照索引として扱います。図だけで完結させず、説明文や図のノードから本文へ戻れるようにします。

Mermaidが見づらい場合の入口として、クリック可能なSVG索引も置きます。

World Foundation ビジュアルリンクマップ

SVG内の各ノードは、主要な設計文書、モジュール索引、提案、意思決定、用語集へリンクします。GitHub上で画像としてだけ見える場合は、SVGファイル を直接開いて使います。

flowchart TB
  Overview["00<br/>全体像"]
  Layers["01<br/>層構造"]
  モジュール["02 / 09<br/>モジュール関係"]
  ガバナンス["03<br/>運用フロー"]
  ロードマップ["04<br/>移行ロードマップ"]
  安全方針["05<br/>安全装置"]
  翻訳["06<br/>翻訳フロー"]
  LifeAccess["07<br/>生活アクセス"]
  Adoption["08<br/>非強制の普及"]

  Overview --> Layers
  Layers --> モジュール
  モジュール --> ガバナンス
  モジュール --> LifeAccess
  モジュール --> 安全方針
  ガバナンス --> 安全方針
  Layers --> ロードマップ
  ロードマップ --> Adoption
  翻訳 --> ガバナンス

  click Overview "/en/diagrams/00-world-design-overview/" "全体像"
  click Layers "/en/diagrams/01-cooperation-foundation-layers/" "層構造"
  click モジュール "/en/diagrams/02-module-relationships/" "モジュール関係"
  click ガバナンス "/en/diagrams/03-governance-process/" "運用フロー"
  click ロードマップ "/en/diagrams/04-transition-roadmap/" "移行ロードマップ"
  click 安全方針 "/en/diagrams/05-risk-and-safety-loops/" "安全装置"
  click 翻訳 "/en/diagrams/06-multilingual-document-flow/" "翻訳フロー"
  click LifeAccess "/en/diagrams/07-life-access-model/" "生活アクセス"
  click Adoption "/en/diagrams/08-non-coercive-adoption/" "非強制の普及"
役割主な詳細文書
世界設計の全体像世界設計の全体像ビジョン, 設計原則, ビジュアルリンクマップ
協力基盤の層構造協力基盤の層構造アーキテクチャ, モジュール, 拡張モジュール関係図
モジュール関係図モジュール関係図モジュール, アーキテクチャ, 脅威モデル
ガバナンスプロセスIssueから意思決定までの流れ提案, 意思決定, ガバナンスモジュール
移行ロードマップ既存制度から協力基盤への段階的移行ロードマップ, 非強制の普及モデル, 調査
リスクと安全性のループ腐敗耐性と安全装置脅威モデル, 対象外, 安全方針
多言語ドキュメント運用日本語正本と翻訳の管理フロー翻訳ステータス, 英語版文書, 用語集
生活アクセスモデル生活アクセスの設計モデル生活アクセスの持続可能性, 福祉モジュール, 経済モジュール
非強制の普及モデル非強制の普及モデル設計原則, ビジョン, 移行ロードマップ
拡張モジュール関係図規範 / 公共安全 / 連合を含む拡張モジュール関係図アーキテクチャ, モジュール, モジュール関係図

Mermaidは、GitHub上で表示でき、差分レビューしやすい初期形式として使います。ただし、読みやすい公開図、クリック可能な索引、議論用の手描き図までMermaidだけで済ませません。図の目的に応じて、次の形式を使い分けます。

形式使う場面このリポジトリでの扱い
Mermaidフロー、関係図、レビュー中の設計メモMarkdown内の軽量な図として使う。見た目を詰めすぎない
SVG主要な全体図、クリック可能な索引、公開向けの清書Markdown図が読みにくい場合の代替入口にする
Excalidraw構想段階の手描き風整理、議論中の概念図議論用。採用する場合は .excalidraw と書き出し画像をセットで置く
diagrams.net / draw.io複雑な構造図、公開資料用の清書XML差分が大きいため、更新理由と書き出し先を明記する
D2 / Graphviz大きな依存関係、モジュール間関係の自動レイアウト生成手順を残せる場合に採用する
Markdown table図と本文の対応表、読み順、責任範囲リンクの正本として扱う。図だけではなく表でも辿れるようにする

当面は、Markdownページを正本にし、Mermaidはその中の図表現として扱います。中心となる図はSVGやExcalidrawなどを併用できます。併用する場合は、正本ファイル、書き出しファイル、更新手順を同じディレクトリ内に明記します。

リンクは、独立したリンク一覧として積み上げるのではなく、できる限り説明文、表、Mermaidの click、SVGノードの中へ埋め込みます。

図と本文のどちらから読んでも同じ設計判断へ戻れるようにします。Mermaidを使う場合も、単なる挿絵にせず、ノードを対応する本文、図表、IssuePull Request へ接続します。リンク集は索引ページや表が必要な場合だけにします。

現時点の図表は、レビューしやすいMermaid入りMarkdownを中心に管理します。ただし、Mermaidが読みづらい場面ではSVG索引やMarkdown表を優先して補います。

図は完成図ではなく、議論のための設計メモです。構造が変わった場合は、対応するdocs、modules、glossary、提案、意思決定と一緒に更新します。Mermaid以外の形式を採用する場合も、変更理由と更新手順を残します。