Inside Tech Comm with Zohra Mutabanna
Technology
As technical communicators, this challenge most likely resonates with you -- how do you keep docs in sync with your product? In the words of Manny Silva, "When product updates are frequent and user expectations are high, maintaining accurate and up-to-date documentation isn’t just a necessity—it’s a competitive advantage."
Manny proposes. Docs as Tests, a strategy that keeps your docs in sync with your product. It’s a way to test your docs, just like engineers test their code.
As Manny joins me, we unravel the story of Doc Detective—an innovative tool that challenges the status quo by ensuring documentation remains in lockstep with product functionality. Through a case study and demo, Manny shares how Doc Detective tests your content against your product UIs and APIs to ensure that your docs are always accurate, complete, and relevant.
Where can you view the demo?
View the demo (24:04 to 34:24) at this link.
Resources
Events to attend where Manny will be presenting in 2024
Guest Bio
A tech writer by day and engineer by night, Manny Silva is Head of Docs at Skyflow, codifier of Docs as Tests, and the creator of Doc Detective. He’s passionate about intuitive and scalable developer experiences and likes diving into the deep end as the 0th developer.
Show Credits
S5E5 Mastering AI-enhanced Content Creation using Retrieval-Augmented Generation (RAG) with Manny Silva
S5E4 Mastering Project Management as Content Creators with Kieran Morgan
S5E3 Regulated Content: Enhance compliance and collaboration with Quark Software
S5E1 Redefining Note-Taking and the Art of Knowledge Organization with Jorge Arango
S4E11 Glimpse into the Future of Technical Writing with AI with Caity Cronkhite
S4E10 Optimizing Visual Content in Technical Documentation with Daniel Foster
S4E9 A Deep Dive into Universal Design and Accessible Content with Lindsey White
S4E8 Redefining Content Creation with AI with Matt Thomas
S4E7 Bridging the Gap: How AI is Reshaping Technical Communication with Ryan Boettger
S4E6 Empathy and Innovation in the Age of AI and Remote Work
S4E5 Navigating the Future of AI-Driven Writing with Kathleen Majorsky
S4E4 AI and Tech Comm - Using ChatGPT Smartly to Enhance Your Career with Shaughn Kern
S4E3 AI Translation - Dos and Don'ts with Markus Seebauer
S4E2 Content Research for Better UX with Erica Jorgensen
S4E1 Partner up with Artificial Intelligence (AI)
S3E9 Smart Strategies for Saving Costs with Machine Translation and Going Global with Lisa Zarfl
S3E8 Through the Lens of a Scrum Master - Speak Up and Advocate for Yourself with Jennifer Savage
S3E7: Documentation is your Frontline Defense - Find Out How with Caity Cronkhite
S3E6: Embrace Discomfort and Challenge the Status Quo for Advocacy and Visibility with Swapnil Ogale
Create your
podcast in
minutes
It is Free
Insight Story: Tech Trends Unpacked
Zero-Shot
Fast Forward by Tomorrow Unlocked: Tech past, tech future
The Unbelivable Truth - Series 1 - 26 including specials and pilot
Lex Fridman Podcast