tekom - conferences

Code-as-Doc and Docs-as-Code -- Single Sourcing for Consistent Quality

  • Presentation
  • Content Creation
  •  Renate Kempf

    Renate Kempf

    • VMware

Takeaways

Accurate and up-to-date information is a must! For part of our doc set, we're therefore collaborating with engineering. The content (setup steps) are shown in product and added to the doc set by a script. Source is in Markdown, but lives in a private (product) and public (doc) Github repo. As a final step, writers now add information to some of the product files for accurate and easy to ready output in both places.

Content

Similar tools and processes can result in excellent collaboration between engineering and doc team. The shared responsibility and contributions from both teams has resulted in mutual respect and more accurate content. 

Prior knowledge

No prior knowledge, but interest in new technology

Speaker

 Renate Kempf

Renate Kempf

  • VMware
Biography

Renate Kempf is a Senior Staff Tech Writer at Wavefront by VMware. After getting an M.A. and Ph.D., she fell in love with explaining complicated things to engineers. She believes docs as code can help with documentation quality and consistency and make tech writers' lives easier.