R&D LAB Methode Im Einsatz Für das eigene Team gebaut

iiterate Handbook

Ein Thema als zweisprachiges Lernhandbuch mit Abschlussnachweis

Ein Thema, ein Handbuch: Lektionen mit Quellen, Verständnischeck und Bestätigung, auf Deutsch und Englisch, nachverfolgt bis zum Abschluss.

  • 2Sprachen in jeder Lektion, live umschaltbar
  • 3Bereiche im Leser: Navigation, Lektion, Arbeitsbereich
  • 5Werkzeuge je Lektion: Notizen, Kommentare, Checkliste, Links, Marker
  • 1Thema je Handbuch
Startseite der Handbuch-Bibliothek: Überschrift One topic. One handbook. Tracked to completion., darunter eine Reihe mit Kapitelkarten, jede mit Nummer, Titel, Anzahl der Module und Lektionen und der Markierung Open; oben rechts Umschalter für Englisch, Deutsch und dunkles Design

Startseite der Bibliothek mit einer Reihe von fünf Kapiteln zu Sicherheit und Vertrauen, geschrieben für das eigene Team. Deren Inhalte sind intern und hier nicht beschrieben.

Publikationsgrund

Wir verkaufen KI und technische Kommunikation. Das Handbuch ist der Beleg für beides an einer unscheinbaren Aufgabe: verstreutes Fachwissen in Material zu überführen, das gegliedert ist, seine Quellen nennt und dessen Durcharbeitung sich nachweisen lässt. Das Sprachmodell schreibt dabei nicht ins Leere, sondern füllt einen festen Aufbau, in dem eine fehlende Quelle als Lücke auffällt. Wer Einarbeitung, interne Schulung oder Sensibilisierung für Datenschutz und Informationssicherheit strukturieren will, sieht hier, wie wir das für unser eigenes Team gebaut haben.

Fachwissen liegt in Köpfen, in Foliensätzen und in Wiki-Seiten, die niemand abschließen kann. Eine Schulung ist ein Termin, danach bleiben eine Teilnehmerliste und die Fragen, die im Raum gestellt wurden. iiterate Handbook macht aus einem komplexen Thema ein interaktives Lernhandbuch auf Deutsch und Englisch. Am Anfang stehen ein Auftrag und eine Klärung: für wen, wie tief, in welchen Sprachen und gestützt auf welche Normen und Gesetze. Dann folgen die Recherche der Quellen, Module in Lernreihenfolge und Lektionen mit demselben festen Aufbau, ein Glossar und ein Themengraph, der wiederkehrende Begriffe über Lektionen hinweg verbindet, und ein Leser in drei Bereichen mit Notizen, Kommentaren, Markierungen und einem Abschlussnachweis. Ein Sprachmodell hilft beim Entwerfen und Gliedern der Lektionen; die Vorlage verlangt Belege im Text und eine Quellenliste, und die offenen Fragen der Lernenden werden für die nächste Überarbeitung gesammelt.

Die Entscheidung

Eine Lektion ist erst fertig, wenn jemand sie bestätigt hat

Eine Wiki-Seite weiß nicht, ob sie gelesen wurde, und ein Foliensatz nennt selten, woher seine Aussagen stammen. Beides ist harmlos, solange es um Allgemeinwissen geht, und wird unangenehm, sobald eine Organisation zeigen soll, dass ihr Team eine Regel kennt. Die Entscheidung am Anfang war deshalb, jede Lektion als nachverfolgte Einheit zu bauen und nicht als Seite.

Jede Lektion endet in einem kurzen Verständnischeck mit Fragen zum Inhalt. Erst wenn er bestanden ist, lässt sich die Lektion bestätigen: Name, der Satz, dass sie gelesen und verstanden wurde, und das Datum. Der Fortschrittsbalken im Kopf zählt bestätigte Lektionen, nicht geöffnete, und ein Knopf exportiert daraus eine Tabelle mit Name, Handbuch, Modul, Lektion und Datum.

Wo ein Fehler Folgen hat, kommt eine Sorgfaltscheckliste hinzu. Ist sie als verpflichtend markiert, bleibt die Bestätigung gesperrt, bis jeder Punkt abgehakt ist. Dieselbe Strenge gilt für die Belege: Die Vorlage sieht Quellenangaben direkt am Abschnitt und eine Quellenliste am Ende vor. Das Sprachmodell füllt diesen Aufbau, und ein Abschnitt ohne Beleg fällt beim Lesen als Lücke auf, statt in einem Fließtext zu verschwinden.

Was das nicht ist, gehört dazu. Die Bestätigung ist eine Selbstauskunft mit eingetipptem Namen, keine Prüfung mit Anmeldung, und der Check ist ein kurzer Auswahltest, kein Examen. Notizen, Fortschritt und Bestätigungen liegen im Browser, bis jemand sie in die Handbuchdateien zurückschreibt. Eine Benutzerverwaltung für viele Lernende gibt es nicht.

Eine Wiki-Seite kann niemand abschließen. Eine Lektion schon.

Vom Thema zum Handbuch

Sechs Schritte, und geschrieben wird erst ab dem fünften

  1. 01 Auftrag klären Festgehalten wird, für wen das Handbuch ist, welche Rollen es gibt, wie tief es gehen soll, in welchen Sprachen, welche angrenzenden Themen dazugehören, wo verpflichtende Checklisten nötig sind und welche Normen und Gesetze zitiert werden. Daraus entsteht ein Vorschlag für Module und Lektionen, der vor dem Schreiben freigegeben wird.
  2. 02 Mission Eine kurze Mission beschreibt, was die Lernenden am Ende können sollen, warum es für sie zählt, wo sie starten und woran man erkennt, dass das Ziel erreicht ist. Jede Lektion bezieht sich darauf.
  3. 03 Quellen Die Recherche landet in einer Quellentabelle mit Vertrauensstufe und Verwendung. Videos lassen sich über ihre Untertitel transkribieren, mitgelieferte Dokumente vertiefen die passenden Module.
  4. 04 Gliederung Module stehen in Lernreihenfolge, weil spätere auf früheren aufbauen. Jede Lektion behandelt genau eine eng umrissene Sache und nennt die wiederkehrenden Themen, die sie berührt.
  5. 05 Lektionen Ein Sprachmodell entwirft jede Lektion entlang des festen Aufbaus, Deutsch und Englisch in derselben Datei. Die Lektion ist eine eigenständige HTML-Seite, die sich auch außerhalb des Lesers öffnen und drucken lässt.
  6. 06 Bauen Ein Skript liest alle Lektionen ein, berechnet Fortschritt und Themengraph und erzeugt den Leser als eine einzige Datei. Die Startseite der Bibliothek entsteht dabei jedes Mal neu.

Was jede Lektion enthält

01 Versprechen und Relevanz Ein Satz, was man nach der Lektion kann, und ein Abschnitt, warum es zählt, bezogen auf die Mission des Handbuchs.
02 Lehrabschnitte mit Belegen Mehrere Abschnitte, in denen jede nicht offensichtliche Aussage einen Beleg trägt. Randnotizen stehen sparsam daneben: links, was man wissen, rechts, was man tun sollte.
03 Durchgespieltes Beispiel Ein konkretes Beispiel, bei technischen Themen ergänzt um Codeblöcke, Konfigurationstabellen, Gegenüberstellungen von unsicherem und sicherem Code oder nummerierte Abläufe.
04 Sorgfaltscheckliste Bei heiklen Aufgaben eine Checkliste am Rand. Ist sie als verpflichtend markiert, sperrt sie die Bestätigung, bis alles abgehakt ist.
05 Übung, Kurzfassung, Querverweise Eine Übung, eine Kurzfassung zum Nachschlagen und Verweise auf Lektionen, die denselben Begriff in anderem Zusammenhang behandeln.
06 Quellen, Check, Bestätigung Die Quellenliste der Lektion, der Verständnischeck und die Bestätigung mit Name und Datum, die im Fortschritt zählt.

Der Leser in drei Bereichen

Leseransicht eines Handbuchs: oben Titel, Fortschritt und Kapitelreiter; links die Lektionsliste nach Modulen mit Kontrollkästchen; in der Mitte die Lektion OWASP Top 10 (Web) mit Lernziel und einer Werkzeugleiste mit Bearbeiten, Fokus, Drucken, Öffnen im neuen Tab und dem Knopf Attest & complete; rechts die Reiter Notes, Comments, Checklist, Links und Marks mit leerem Notizfeld; unten Sync to store, Record und Akzentfarben
Eine Lektion zu den OWASP Top 10, allgemeines Fachwissen. Der Fortschritt steht auf 0 von 25, weil in dieser Aufnahme noch keine Lektion bestätigt ist.

Links liegen die Lektionen nach Modulen, mit Suche und einem zweiten Reiter für das Glossar. In der Mitte läuft die Lektion, rechts der Arbeitsbereich für genau diese Lektion: Notizen, die sich selbst speichern, Kommentare, die sich an eine markierte Textstelle binden lassen, eine eigene Checkliste, die Quellen der Lektion samt eigener Links und die gesetzten Marker. Ein Lesezeichen entsteht nur, wenn jemand markierten Text ausdrücklich speichert.

Der Fokusmodus blendet beide Seitenleisten aus, und Drucken gibt nur die Lektion aus, nie die Navigation. Im Bearbeitungsmodus lassen sich Text und Randnotizen ändern, Stellen hervorheben und Notizen verschieben; diese Änderungen werden beim Zurückschreiben Teil der Lektionsdatei. Die Zeile unten zählt Änderungen, die bisher nur im Browser liegen, in dieser Aufnahme zwei.

Wiederkehrende Begriffe verbinden die Lektionen

Jede Lektion nennt die Themen, die sie berührt. Beim Bauen entsteht daraus ein Themengraph: Ein Thema ist ein Glossarbegriff oder ein Begriff, den mindestens zwei Lektionen nennen, und es wird mit jeder Lektion verbunden, in der es vorkommt. Die Glossareinträge erfahren dabei automatisch, in welchen Lektionen sie auftauchen, auch wenn beim Schreiben niemand daran gedacht hat.

Im Leser steht das Glossar links neben der Lektion, jeder Begriff mit Definition in beiden Sprachen und Verweisen auf die Lektionen, die ihn verwenden. Die Übersicht zeigt denselben Zusammenhang als Graph: Themen als Quadrate, Lektionen als Punkte in der Farbe ihres Moduls, mit Filter, Suche und einem Klick, der die Lektion öffnet.

Das funktioniert nur, wenn dieselbe Sache überall gleich heißt. Deshalb werden die Themen einer Reihe einmal benannt und in allen Kapiteln wörtlich wiederverwendet; zwei verschiedene Bezeichnungen für dieselbe Sache ergeben zwei Themen.

Leseransicht mit geöffnetem Glossar-Reiter links: die Begriffe TLS, WAF und Key management, jeweils mit der Markierung recurs, einer Definition und Verweisen auf Lektionen; in der Mitte die Lektion OWASP Top 10 (Web)
Das Glossar neben der Lektion. Jeder Begriff trägt Verweise auf die Lektionen, in denen er vorkommt; der Graph der Übersicht ist hier nicht abgebildet.

Was sich gegenüber einer Schulungsunterlage ändert

Übliche Schulungsunterlage

  • Folien ohne Quellen, oder mit einer Liste am Ende, die niemand einer Aussage zuordnen kann.
  • Eine Sprache, oder zwei Fassungen, die mit jeder Änderung weiter auseinanderlaufen.
  • Eine Teilnehmerliste als Nachweis, aber keine Aussage darüber, wer was durchgearbeitet hat.
  • Fragen aus dem Termin, die nach dem Termin verloren sind.
  • Korrekturen, die in einer Kopie landen und nie in der Vorlage.

Handbuch

  • Belege am Abschnitt und eine Quellenliste je Lektion.
  • Deutsch und Englisch in derselben Lektionsdatei, umschaltbar im Leser.
  • Eine Bestätigung je Lektion mit Name und Datum, hinter einem Verständnischeck, als Tabelle exportierbar.
  • Offene Fragen je Lektion, gesammelt in einer Liste für die nächste Überarbeitung.
  • Änderungen am Text, die in die Lektionsdatei zurückgeschrieben werden und damit für alle gelten.

Bibliothek

Reihen und Kapitel statt loser Handbücher

Ein Thema bleibt ein Handbuch. Gehören mehrere Themen zusammen, werden sie als geordnete Kapitel einer Reihe verknüpft, ohne dass eines das andere überschreibt. Jedes Handbuch einer Reihe erhält unter dem Kopf eine Kapitelleiste, die zu den anderen Kapiteln springt, und die Startseite der Bibliothek zeigt jede Reihe als Folge von Kapitelkarten mit Farbe, Umfang und Fortschritt, dazu die einzelnen Handbücher und eine kurze interaktive Anleitung.

Ob ein Kapitel schon gebaut oder erst geplant ist, steht nirgends als gepflegter Status. Es wird beim Bauen daraus abgeleitet, ob für dieses Kapitel ein Leser existiert. Ein geplantes Kapitel erscheint deshalb als geplant, bis es tatsächlich gebaut ist, und kann nicht versehentlich als verfügbar gelten.

Die abgebildete Bibliothek enthält eine mehrteilige Reihe zu Sicherheit und Vertrauen, geschrieben für das eigene Team. Aus ihr zeigt dieser Artikel nur eine Lektion mit allgemeinem Fachwissen.

Wofür das passt

  • Einarbeitung neuer Mitarbeitender in interne Arbeitsweisen, Werkzeuge und Regeln.
  • Einweisung von Partnern und Dienstleistern in die Bedingungen, unter denen sie mit Daten oder Systemen arbeiten.
  • Sensibilisierung für Datenschutz und Informationssicherheit, bei der festgehalten werden soll, wer welche Lektion bestätigt hat.
  • Übergabe eines Softwareprojekts an das Team, das es weiter betreibt, mit Lektionen zu Aufbau und Abläufen.
  • Begleitmaterial zu Workshops, das nach dem Termin als Nachschlagewerk weiter nutzbar ist.

Bildnachweis: Alle Aufnahmen sind Screenshots unserer eigenen Anwendung. OWASP Top 10 ist ein Projekt der OWASP Foundation; die gezeigte Lektion ist eigenes Lehrmaterial dazu.

Publikationsgrund

Was das für Ihr Projekt heißt

Weiteres aus dem Lab

Liegt bei Ihnen Wissen in Köpfen und Foliensätzen, das jede neue Person wieder erfragen muss? Genau dafür gibt es einen Piloten.

Kontakt aufnehmen

Grace Hopper

“Der schädlichste Satz der Sprache lautet: Das haben wir schon immer so gemacht.”