High-quality and Consistent Content Using Docs-as-Code Tools and Processes
- Software Documentation
- 10. June
- 16:30 - 17:30 PM (CET)
- finished Presentation Slides
-
Shavindri Dissanayake
- VMware
-
Renate Kempf
- VMware
Contents
Technical writers can use docs-as-code processes and tools for single-sourced, up-to-date content. This presentation explores the processes we use to single source content in the product (login required) and in the doc (freely available). We discuss the tools we’re using (git, Markdown, Jekyll) and why, the process we use to review the in-product documentation, and the scripts we developed to add the content to the doc set.
Takeaways
The collaboration resulted in big gains for the product team, customers appreciate having docs without logging in, having content in sync prevents issues with outdated docs, and handling doc bugs is now an interesting challenge.
Prior knowledge
No experience necessary! This presentation is for anyone who is interested in docs as code processes: Technical writers, developers who write, tech writing managers.