Docs-as-Code with Sphinx and reStructuredText

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

    Hans-Jörg Elsen

    • CONTACT Software 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

  • CONTACT Software GmbH
Biografie

Hans-Jörg Elsen holds a Master of Arts in German Linguistics and Electrical Engineering from the University of Technology (RWTH) Aachen.

He has been working as a Technical Communicator for more than 20 years in different technology industries like Software Development and Medical Device Engineering.

His special interests are User Assistance and Usability Engineering. In his current role as a Software Documentation Manager at CONTACT Software, Hans-Jörg focuses on contributing to the overall software UX with improved User Assistance and documentation. Furthermore, he is an assistant lecturer at the University of Applied Sciences in Cologne.

Hans-Jörg Elsen holds a Master of Arts in German Linguistics and Electrical Engineering from the University of Technology (RWTH) Aachen.

He has been working as a Technical Communicator for more than 20 years in different technology industries like Software Development and Medical Device Engineering.

His special interests are User Assistance and Usability Engineering. In his current role as a Software Documentation Manager at CONTACT Software, Hans-Jörg focuses on contributing to the overall software UX with improved User Assistance and documentation. Furthermore, he is an assistant lecturer at the University of Applied Sciences in Cologne.

 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.