The Unanticipated Challenges of Docs-as-Code for Tech Docs

Navigate the complexities of using Markdown in large-scale technical documentation projects with insights from Matt Briggs, Senior Product Manager at Microsoft. In this episode of Coffee and Content, Matt will delve into the inherent challenges that arise when Docs-as-Code practices meet expansive tech doc requirements. Markdown has become a staple in small-scale, developer-close environments due to its simplicity and clarity. However, as your documentation needs grow, the limitations of Markdown—such as its conflation of content and presentation—can hinder scalability, reusability, and integration with advanced AI technologies like LLMs and RAGS. Matt will explore how these challenges manifest and what you can do to address them effectively. Expect to learn about the benefits of adopting a semantic approach to documentation that clearly labels parts for both humans and machines. Discover how separating content from presentation can not only enhance the manageability of your docs but also open up new possibilities for creating dynamic content pipelines and multi-format outputs. Coffee and Content is brought to you by The Content Wrangler and sponsored by Heretto, a powerful component content management (CCMS) platform designed to deploy help and API docs in a single portal that delights your customers. Can’t make it? Register, and we’ll send you a link you can use to watch a recording when it’s convenient for you.