tekom - conferences

Docs-as-Code with Sphinx and reStructuredText

  • Presentation
  • Software Documentation
  •  Hans-Jörg Elsen

    Hans-Jörg Elsen

    • CONTACT Software GmbH
  •  Luca Raimondo

    Luca Raimondo

    • CONTACT Software GmbH

Takeaways

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.

Content

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.

Speakers

 Hans-Jörg Elsen

Hans-Jörg Elsen

  • CONTACT Software GmbH
Biography

Hans-Jörg Elsen studied German Linguistics and Electrical Engineering at the University of Technology Aachen and has been working as Technical Communicator in different industries since then. At CONTACT Software he focuses on contributing to the software User Experience with improved User Assistance.

 Luca Raimondo

Luca Raimondo

  • CONTACT Software GmbH
Biography

Luca Raimondo studied Digital Media at the University of Bremen and has been working as a software developer in the UX team at CONTACT Software since then. His focus is on tooling and documentation for colleagues and partners, as well as DevOps tasks in the environment.