Produkt

Handgezeichnete Diagramme: warum die beste Engineering-Doku ein bisschen skizziert ist

Ein pixelgenaues Diagramm sagt "nicht anfassen". Handgezeichnete Diagramme sagen "hilf mir, das richtig zu machen".

Sieh dir zwei Versionen desselben Architekturdiagramms an. Die eine ist gestochen scharf: perfekt gerade Linien, am Raster ausgerichtete Kästen, einheitliche Ecken. Die andere wirkt handgezeichnet, die Striche etwas locker, als hätte sie jemand vor fünf Minuten an ein Whiteboard skizziert. Jetzt stell dir eine ehrliche Frage. Auf welcher würdest du dich trauen herumzukritzeln?

Fast alle zeigen auf die skizzenhafte. Dieser Instinkt ist kein Zufall, und er verrät etwas Wichtiges darüber, wie Engineering-Dokumentation tatsächlich genutzt, ignoriert oder still und leise aufgegeben wird.

Die Psychologie des Feinschliffs

Ein starres, pixelgenaues Diagramm trägt eine versteckte Botschaft: Das hier ist fertig. Jede Linie ist bewusst gesetzt, jeder Kasten sitzt, wo er hingehört, jemand hat sichtlich echte Mühe darauf verwendet, es offiziell aussehen zu lassen. Und fertige Dinge laden nicht zum Bearbeiten ein. Sie laden zum Nicken ein. Wenn ein Diagramm aussieht, als käme es aus der Druckerpresse, fühlt sich Hinterfragen an wie das Beschmieren eines Denkmals, also sagt die Person, die die fehlende Queue oder den falschen Pfeil bemerkt, einfach still nichts.

Ein handgezeichneter Look bewirkt das Gegenteil. Er wirkt wie etwas in Arbeit, eine gemeinsame Skizze statt einer Verlautbarung. Genau diese niedrigere Hürde ist der Punkt. Leute zeigen auf eine grobe Zeichnung, kreisen den Teil ein, der falsch aussieht, und sagen "Moment, ist der Cache jetzt nicht hier drüben?" Die Unvollkommenheit ist eine Einladung.

Ein Diagramm, das unfertig aussieht, wird korrigiert. Ein Diagramm, das fertig aussieht, wird ignoriert.

Steif: "Finger weg" Skizze: "hilf mir dabei" web api web api cache?
Dieselben zwei Services. Die starre Version wirkt offiziell und abgeschlossen; die skizzenhafte lädt zur Randnotiz "cache?" ein.

Die Aufmerksamkeit gilt der Idee, nicht den Pixeln

Es gibt einen zweiten, leiseren Vorteil. Wenn ein Diagramm ordentlich aussehen soll, fängt die Person, die es erstellt, an, sich um die falschen Dinge zu kümmern: Ist dieser Kasten an jenem ausgerichtet, sind die Abstände gleich, warum ist dieser Pfeil einen Pixel daneben. Dieses Herumfeilen ist eine Steuer aufs Denken. Es zieht die Aufmerksamkeit von der eigentlichen Frage ab, nämlich ob die Kästen und Pfeile das System korrekt beschreiben.

Ein handgezeichneter Stil schafft diese Steuer ab. Niemand erwartet, dass eine Skizze perfekt ausgerichtet ist, also verbringt niemand zwanzig Minuten damit, Rechtecke zurechtzurücken. Die Energie bleibt bei den Ideen und ihren Beziehungen zueinander. Und weil die Zeichnung schnell und ohne viel Risiko entsteht, wird das frühe Diagramm tatsächlich gemacht, statt das Ding zu bleiben, das du ständig machen willst, "sobald wir Zeit haben, es hübsch zu machen".

  • Grobe Zeichnungen gehen schnell, also entstehen sie zu Beginn eines Designs, wenn sie am meisten helfen.
  • Geringer Einsatz heißt, dass Leute eine wegwerfen und neu zeichnen, statt versunkene Kosten zu verteidigen.
  • Weil sie billig zu erstellen sind, sind sie auch billig aktuell zu halten, und nur so bleibt ein Diagramm wahr.

Das ist der eigentliche Grund, warum ein Diagramm-Tool mit handgezeichnetem Stil eher mehr Dokumentation hervorbringt, nicht weniger. Die Hürde des Anfangens bringt die meisten Diagramme um, und Feinschliff ist eine Hürde, die sich als Tugend verkleidet.

Lass die Zeichnung sich selbst erklären

Ein Bild beantwortet "was ist womit verbunden" wunderbar und "warum" überhaupt nicht. Genau dort driften Diagramme und ihre Beschreibungen meist auseinander: Die Zeichnung lebt an einem Ort, der erklärende Absatz an einem anderen, und sie altern unterschiedlich schnell.

LetDraw schließt diese Lücke mit Diagramm erklären. Richte es auf eine Zeichnung, und es macht aus den Formen und Verbindungen klare Prosa oder Markdown, eine schriftliche Beschreibung des Systems, die zum Bild passt, weil sie daraus generiert wurde. Ein Diagramm kann seine eigene Beschreibung mitbringen, sodass Doku und Zeichnung zwei Ansichten einer Sache bleiben, statt zwei Dinge, die sich widersprechen.

Gut zu wissen. Der handgezeichnete Look ist eine Wahl, keine Einschränkung. Wenn du etwas Gestochenes für eine formale Spezifikation oder ein Dokument für Kunden brauchst, wechsle zu einem sauberen, nicht skizzenhaften Stil, und dasselbe Diagramm wird scharf dargestellt.

Skizzenstil, absichtlich grob

Nichts davon ist ein Argument gegen Sorgfalt. Es ist ein Argument darüber, wann Feinschliff hilft und wann er schadet. Früh, solange ein Design noch weich ist und du willst, dass Leute widersprechen, lädt eine Skizze zu dem Widerspruch ein, der das Design besser macht. Später, wenn eine Entscheidung feststeht und du sie einem Auditor oder einer neuen Kollegin übergibst, ist gestochen scharf genau richtig, und das ist nur einen Schalter entfernt.

Die beste Engineering-Doku ist die, die Leute lesen, hinterfragen und aktuell halten. Meistens ist das die, die ein bisschen handgezeichnet aussieht, weil sie immer noch so wirkt, als bitte sie um deine Hilfe. Öffne eine Leinwand, skizziere zuerst die unordentliche Version, und lass das Diagramm sich seinen Feinschliff später verdienen.

Erst skizzieren, später verfeinern

Zeichne die grobe Version, lass "Diagramm erklären" die Beschreibung schreiben und wechsle zu einem sauberen Stil, wenn du ihn brauchst.

LetDraw kostenlos öffnen