Guidedog / Dokumentation 0.2.0

Diagramme zur Erklärung¶

Wählen Sie ein Diagramm passend zur Frage. Ablaufdiagramme erklären Entscheidungen, Blockdiagramme Zuständigkeiten, Sequenzen Reihenfolgen und Graphen Beziehungen. Nutzen Sie Prosa, wenn sie direkter antwortet.

Ein Flussdiagramm¶

Bei ausreichender Kapazität konvertieren; sonst bereitet der Host Speicher vor und versucht es erneut. — Abb. 3 Die Kapazität wird geprüft, bevor Speicher ausgeliehen oder vergrößert wird.¶

Die Zeichnung nennt beim Wachstumsschritt den Eigentümer. Sie deutet keine Allokation durch den Konvertierungskern an. Dieser Unterschied gehört zum Vertrag.

Einen Graphen erstellen¶

.. 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 und digraph sind eingebaut. Guidedog rendert mit Graphviz. HTML erhält SVG, PDF die gerenderte Zeichnung. Beide nutzen denselben Graphquelltext.

Das Ergebnis lesbar gestalten¶

Halten Sie Knotenbeschriftungen kurz. Längere Regeln gehören unter die Zeichnung. Bevorzugen Sie eine Hauptrichtung und beschriften Sie Rückkanten mit Bedingungen. Nutzen Sie Form und Text neben Farbe; Druckleser haben womöglich keine Farbe.

Ergänzen Sie Alternativtext und Bildunterschrift. Prüfen Sie schmale Browserfenster und PDF-Seiten. Braucht das Diagramm winzige Schrift, teilen Sie es. Größen beschreibt Bilder, Video, Audio und Downloads.