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

  • Fachvortrag
  • Inhaltserstellung
  • 09. November
  • 17:30 - 18:15 PM (MEZ)
  • Channel D
  • beendet
  •  Renate Kempf

    Renate Kempf

    • VMware

Inhalt

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.

Das lernen Sie

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. 

Vorkenntnisse

No prior knowledge, but interest in new technology

Referent:in

 Renate Kempf

Renate Kempf

  • VMware
Biografie

Renate Kempf has been a Technical Communicator for over 25 years. After a stint in Academia, she started as a technical trainer with an AI company. She switched to tech writing and had her own business for 20+ years before joining VMware. Her interests include visual communication, docs as code, and collaborative writing. She’s given presentations and workshops on Videos for the Masses, Docs in a SaaS World, and Open Source Docs.

Renate Kempf has been a Technical Communicator for over 25 years. After a stint in Academia, she started as a technical trainer with an AI company. She switched to tech writing and had her own business for 20+ years before joining VMware. Her interests include visual communication, docs as code, and collaborative writing. She’s given presentations and workshops on Videos for the Masses, Docs in a SaaS World, and Open Source Docs.