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
AI and Proactive Reliability with Kolton Andrus [not-audio_url] [/not-audio_url]

Duration: 55:11
Today we're talking with Kolton Andrus, the Founder and CEO of Gremlin, about what happens to reliability when AI is writing most of the code. Kolton helped build the Chaos Engineering practice of both Amazon and Netflix…
Making Data Agent Ready with Andre Elizondo [not-audio_url] [/not-audio_url]

Duration: 51:49
Today we are talking with Andre Elizondo, the Director of Innovation at Mezmo about their open source agentic harness for SREs called AURA. Mezmo got their start handling observability data at scale. Logs, traces, metric…
Exponential Engineers with Ashmeet Sidana [not-audio_url] [/not-audio_url]

Duration: 53:20
Today on the show, we have a special guest — Ashmeet Sidana, the founder of Engineering Capital. Ashmeet started his career as an engineer at some great companies like Hewlett-Packard and Silicon Graphics before founding…
Powered by Neurons with Ewelina Kurtys [not-audio_url] [/not-audio_url]

Duration: 42:33
Today we have Dr. Ewelina Kurtys on the show. Ewelina has a background in Neuroscience and is currently working at FinalSpark. FinalSpark is using live Neurons for computations instead of traditional electric CPUs. The a…
Lessons from Building AI Agents with Rafal Wilinski [not-audio_url] [/not-audio_url]

Duration: 1:08:51
Today we're talking with one of our favorite engineers, Rafal Wilinski. Rafal has been on the cutting edge of AI development in the last few years as he has led AI teams at Zapier and Vendr. Rafal walks us through the ha…
Building a High-Ownership Engineering Culture with Matt Watson [not-audio_url] [/not-audio_url]

Duration: 51:37
If you’ve ever felt like engineering teams are stuck in execution mode—heads down, building what they’re told—then today’s episode is for you. We're talking about what it really takes to build high ownership engineering…
Building CI for the age of AI Agents with Aayush Shah [not-audio_url] [/not-audio_url]

Duration: 1:04:02
Today's episode is with Aayush Shah. Aayush is one of the co-founders of Blacksmith, which is a CI compute platform. Basically, Blacksmith will run your GitHub Actions jobs faster and with more visibility with the standa…
Valkey After the Fork: A Conversation with Madelyn Olson [not-audio_url] [/not-audio_url]

Duration: 1:21:14
Today, we're talking Valkey, Redis, and all things caching. Our guest is Madelyn Olson, who is a principal engineer at AWS working on Elasticache and is one of the most well-known people in the caching community. She was…
Operational Excellence Is the Moat with Sam Lambert [not-audio_url] [/not-audio_url]

Duration: 1:06:12
Today, Sam Lambert from Planetscale is back for a third time. Planetscale just announced Planetscale Postgres, so we had to get Sam back to tell us how and why they decided to add support for Postgres. It's always great…