Guidedog / ドキュメント 0.2.0

図で説明する¶

問いに合う図を選ぶ。フローチャートは選択、ブロック図は責任、シーケンス図は順序、グラフは関係を説明する。文章がより直接答えられるなら文章を使う。

フローチャート¶

容量が足りれば変換する。不足ならホストが領域を用意して再試行する。 — 図 3 記憶領域を借用または拡張する前に、容量を確認する。¶

図は拡張時の所有者を示す。変換コアが割り当てるという意味ではない。この区別は契約の一部だ。

グラフを書く¶

.. graphviz::
   :caption: Parsing precedes resolution.
   :alt: The source becomes a tree, then references are resolved.

   digraph pipeline {
     graph [rankdir=LR, bgcolor="transparent"];
     node [shape=box];
     "source" -> "tree" -> "resolved tree";
   }

graphviz、graph、digraph は組み込み。Guidedog が Graphviz で描画し、HTML は SVG、PDF は描画した図を使う。元のグラフは共通だ。

読みやすく仕上げる¶

ノードのラベルは短く、長い規則は図の下で説明する。主経路は一方向を基本にし、戻りの辺に条件を付ける。色だけでなく形と文字も使う。印刷では色がないかもしれない。

代替テキストとキャプションを付け、狭いブラウザーと PDF で試す。小さすぎる字でなければ収まらない図は二つに分ける。寸法は画像、動画、音声、ダウンロードを参照。