Jahrestagung Programm Detail

Zurück zum Tagungsprogramm

Docs-as-Code with Sphinx and reStructuredText

  • Fachvortrag
  • Softwaredokumentation
  • 09. November
  • 11:00 AM (MEZ) - 11:45 AM (MEZ)
  • Channel D
  • beendet
  • Hans-Jörg Elsen

    Hans-Jörg Elsen

    • Eaton Industries GmbH
  • Luca Raimondo

    Luca Raimondo

    • CONTACT Software GmbH

Inhalt

These days, software companies typically develop their software products in agile teams, which are often also responsible for creating documentation. The “Docs-as-Code” approach integrates documentation authoring into software development workflows to support continuous development and delivery. In our presentation we show how we use Sphinx and reStructuredText to implement and continuously improve Docs-as-Code in our software development.

Das lernen Sie

The audience will learn about the Sphinx documentation environment, the reStructuredText markup language, and how the "Docs-as-Code" approach can be implemented in software documentation with this framework.

Referent:innen

Hans-Jörg Elsen

Hans-Jörg Elsen

  • Eaton Industries GmbH
Biografie

Hans-Jörg Elsen hat Elektrotechnik und Germanistik an der Rheinisch-Westfälischen Technischen Hochschule (RWTH) Aachen studiert und verfügt über eine langjährige Erfahrung als Technischer Redakteur in verschiedenen Technologiebranchen wie Softwareentwicklung, Medizintechnik und Automatisierungstechnik. Darüber hinaus war er als Lehrbeauftragter an der TH Köln tätig. Seine besonderen Interessensgebiete sind Usability Engineering und die Optimierung von redaktionellen Prozessen. In seiner aktuellen Funktion als Technical Copywriter bei Eaton Industries ist er schwerpunktmäßig mit strategischen Maßnahmen zur kontinuierlichen Verbesserung der Content-Entwicklung betraut. 

Luca Raimondo

Luca Raimondo

  • CONTACT Software GmbH
Biografie

Luca Raimondo studied Digital Media at the University of Bremen and has been working at CONTACT Software in the UX team as a Software Developer since summer 2019. His studies were primarily focused on computer science, but automation, tooling and documentation have always been matters of his heart. Luca now takes care of hosting the in-house documentation resources at CONTACT and works on improving the ease and clarity of creating documentation for colleagues.

Luca Raimondo studied Digital Media at the University of Bremen and has been working at CONTACT Software in the UX team as a Software Developer since summer 2019. His studies were primarily focused on computer science, but automation, tooling and documentation have always been matters of his heart. Luca now takes care of hosting the in-house documentation resources at CONTACT and works on improving the ease and clarity of creating documentation for colleagues.

zurück