Komplexes einfach erklärt mit Dr.Explain

Im Wintersemester 2024/25 kam erstmalig das Werkzeug „Dr.Explain“ zur Erstellung von HTML-basierten Onlinehilfen bzw. mobilen Dokumentationen zum Einsatz. Dieses Produkt ist in der Lage, den Aufwand hinsichtlich des benötigten Codes nahezu vollständig zu reduzieren und legt somit den primären Fokus auf die Erstellung der eigentlichen Inhalte.

Auf Nachfrage beim Softwareunternehmen „Indigo Byte Systems LLC“ wurde schnell und unbürokratisch eine Bildungslizenz zur Verfügung gestellt, welche sowohl den genutzten Computerraum als auch die individuelle Verwendung durch die Studierenden umfasst. Nach einigen Wochen Vorlauf mit intensiven Tests der Möglichkeiten und paralleler Erarbeitung der nötigen Kursunterlagen wurde bereits intensiv an Dokumentationen gearbeitet.

In der Software selbst wird zunächst der übliche Strukturbaum mit den einzelnen Unterseiten (Topics) erzeugt. Die behandelten Themenbereiche lassen sich dann komfortabel in einer an Textverarbeitungen angelehnten Oberfläche bearbeiten. Neben typischen Formatierungen über die Einbindung von Bildern, Tabellen und Links sind anpassbare Textblöcke für zusätzliche Informationen wie Warnhinweise verfügbar. Besonders attraktiv ist die Annotation von Bildmaterial wie Screenshots von zu dokumentierenden Programmen. Dabei entstehen farbig hinterlegte Positionsnummern, welchen sich weitere kontextuelle Beschreibungen zuordnen lassen.

 

Oberfläche von Dr.Explain (mit einer Software-Anleitung von Dr. Thomas Meinike)

 

Die erstellten Inhalte lassen sich in die webbasierten Formate HTML und CHM exportieren. Darüber hinaus sind auch Ausgaben als PDF- und Word-Dateien vorgesehen. Für jedes dieser Formate lassen sich umfangreiche Anpassungen wie die Auswahl visueller Designvorlagen vornehmen. Für den HTML-Export kann zusätzlicher CSS- und JavaScript-Code eingebunden werden, was je nach Vorkenntnissen die Flexibilität hinsichtlich der Umsetzung eigener Ideen deutlich erhöht.

Neben den eigentlichen HTML-Seiten werden die im Editor angelegte Navigationsstruktur und der ggf. mit Stichwörtern befüllte Index im Browser dargestellt. Hinzu kommt eine mächtige Volltextsuche über alle Teildokumente hinweg.

 

Browseransicht 

 

Insgesamt konnten sich die Studierenden das Potenzial von „Dr.Explain“ in kurzer Zeit produktiv erschließen. Die Abbildungen zeigen exemplarische Ergebnisse aus den beiden Kursen zur Beschreibung einer Software bzw. eines technischen Gerätes.

 

Ergebnisauszug von Marie Bachmann (BTID23)

 

 

Ergebnisauszug von Julia Evels (MIDMM23)

 

Zusätzlich wurde vom Lehrenden ein XSLT-Ansatz zum „Postprocessing“ der ausgeleiteten HTML-Strukturen entwickelt. Damit lassen sich neben einigen Verbesserungen der Standardkonformität zusätzliche Komponenten wie ein Web-Manifest zur Nutzung der Ergebnisse auf mobilen Endgeräten einbeziehen. Die Details der implementierten Operationen werden in einem separaten Screencast beschrieben.

 

(Text: Dr. Thomas Meinike)