No More Broken Docs with Manny Silva

No More Broken Docs with Manny Silva

Author: Software Huddle July 30, 2024 Duration: 48:10
Today, we have Manny Silva, Head of Docs at Skyflow, on the show to talk about two open source projects he created, Docs as Tests and Doc Detective. Docs as Tests is a framework to make sure that your docs are in sync with your product. It's essentially a way to test your docs just like engineers test their code, and Doc Detective is Manny's implementation of that framework. We discuss the history and motivation behind the projects, what they enable, and how people are using it today. Timestamps 01:57 Intro 06:51 Testing Documentation 09:26 Competing Against 11:26 Docs as Tests & Doc Detective 13:32 How does one apply these ideas? 16:49 How does test writing work? 19:26 Out of the box checks 23:15 Configurations Structure to create tests 24:28 Integration with the normal flow 28:20 Freshness 29:13 Tools used to build it 32:02 Open Source 33:27 Limitations 35:31 MongoDB's version of Docs as tests 36:42 Innovation Engine by Azure 37:27 Teams using Doc Detective 38:12 At Skyflow 40:52 Future 41:41 How to get started 45:18 Rapid Fire Links Docs as Tests: https://www.docsastests.com/ Doc Detective: https://doc-detective.com/

Every week on Software Huddle, Alex DeBrie and Sean Falconer sit down with a different expert from across the tech landscape. The conversations are less about quick tips and more about substantive discussions, digging into the real challenges and decisions behind building software, launching products, and navigating the industry's constant shifts. You'll hear from practitioners who have been in the trenches, offering perspectives that blend deep technical knowledge with hard-won business and entrepreneurial experience. Alex brings his specialized expertise as the author of The DynamoDB Book and an AWS Data Hero, while Sean contributes a unique viewpoint shaped by over two decades as an engineer, founder, and marketing executive, recognized as a Snowflake Data Superhero. Together, they create a space where complex topics in software development and technology trends become accessible and genuinely engaging. This podcast is for anyone who wants to move beyond surface-level news and understand the "why" behind the tools and strategies shaping our digital world. Tune in for a thoughtful huddle that feels more like a candid conversation between colleagues than a formal interview.
Author: Language: en-us Episodes: 79

Software Huddle
Podcast Episodes
Developer Education and Training with Craig Dennis from Twilio [not-audio_url] [/not-audio_url]

Duration: 52:13
In this episode, We spoke with Craig Dennis from Twilio about developer education and training. Craig's been working in the developer education space for a long time and has a ton of experience. And, of course, Twilio is…
Generative AI and LLMs with Dash Desai from Snowflake [not-audio_url] [/not-audio_url]

Duration: 34:31
If you've been involved with the Snowflake world, today's guest probably can skip an introduction as he is the demo king from the Snowflake Summit and well-known within the Snowflake builder community. We're talking abou…
V0 by Vercel, Bun, RCS on Apple Devices, Retool Breach, & more [not-audio_url] [/not-audio_url]

Duration: 49:55
Our special episode is here, and it's all about the latest news. Join Sean and Alex for an in-depth discussion. Follow Alex: https://twitter.com/alexbdebrie Follow Sean: https://twitter.com/seanfalconer Software Huddle ⤵…
Building Generative AI Apps with Hassan El Mghari from Vercel [not-audio_url] [/not-audio_url]

Duration: 45:41
Over the past couple of months, Generative AI has taken the world by storm. OpenAI’s launch of ChatGPT was a turning point. With each iteration, the Transformer has improved its capabilities while the underlying compute…
Scaling MySQL with Sam Lambert from PlanetScale [not-audio_url] [/not-audio_url]

Duration: 1:21:18
What would it look like if databases were built for developers rather than operators? Sam Lambert is the CEO of PlanetScale, a company that provides a managed MySQL database solution. PlanetScale uses Vitess, a database…