Jahrestagung Tagungsprogramm Detail

Zurück zum Tagungsprogramm

Wie gelingt eine Docs-as-Code-Kernsanierung – mühsam renovieren oder gleich alles abreißen?

  • Fachvortrag
  • Softwaredokumentation
  • 11. November
  • 11:30 AM (MEZ) - 12:15 PM (MEZ)
  • C5.2/3
  • Lothar Neumann

    Lothar Neumann

    • MVTec Software GmbH

Inhalt

Unsere Doku-Infrastruktur war in die Jahre gekommen: reich an Features, perfekt in die Produkte integriert, aber deshalb auch etwas altbacken, zu komplex und kaum zu warten. Und jedes Produkt machte sein eigenes Ding.
Etwas Neues musste her – nicht mehr LaTeX und viel Eigengewächs, aber was stattdessen?

Diese noch nicht ganz abgeschlossene Reise zu Markdown und MkDocs (und später Zensical), einschließlich ihrer Umwege, soll hier beleuchtet werden.

Es gibt Einblick in gemachte Erfahrungen mit einem Migrationsprojekt im agilen Softwareumfeld sowie dezenten technischen Hintergrund zu Material for MkDocs/Zensical. Ein bisschen Information zu Python-Plugins, Git-Repositories, Build-Pipelines oder Suchmaschinen könnte auch vorkommen, aber eher wenig AI (falls erlaubt).

Das lernen Sie

Antworten auf Fragen wie:

  • Wir haben Änderungsbedarf – und nun?
  • Was spricht für Docs-as-Code und was dagegen?
  • Was bringt mir externe Hilfe?
  • Darf ich meinen Plan hinterher noch ändern?
  • Und wie lange dauert das alles?

Referent:in

Lothar Neumann

Lothar Neumann

  • MVTec Software GmbH
Biografie

Lothar Neumann hat ursprünglich in Frankfurt Physik studiert, ist aber inzwischen schon zwanzig Jahren in München als Technischer Redakteur in der Software-Industrie aktiv, seit 2019 bei der MVTec Software GmbH.

Neben den täglichen Bemühungen, den Kunden bei der Lösung diverser Machine Vision-Aufgaben mit Anleitungen beizustehen, leitet er ein Projekt, um das Herstellen dieser Anleitungen auf eine neue technische Basis zu stellen.

Ob XML, LaTeX, Markdown, AsciiDoc – immer gern als "Docs-As-Code" (auch wenn es zu Beginn noch gar nicht so hieß).

Lothar Neumann originally studied physics in Frankfurt, but has been working as a technical writer in the software industry in Munich for twenty years now, and has been with MVTec Software GmbH since 2019.

In addition to his daily efforts helping customers solve various machine vision tasks with documentation, he is leading a project to move the production of said documentation onto a new technical foundation.

Whether it's XML, LaTeX, Markdown, or AsciiDoc—he's always been a fan of "Docs-As-Code" (even before the term actually existed).

zurück