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
Architecting for SaaS with Bill Tarr [not-audio_url] [/not-audio_url]

Duration: 1:09:53
This week on the show, we talk with Bill Tarr, Principal Solutions Architect at AWS SaaS Factory. He's a super thoughtful guy, expert in SaaS architecture and architectural patterns. We talk about tenancy, infrastructure…
High Performance Postgres with Andrew Atkinson [not-audio_url] [/not-audio_url]

Duration: 1:13:55
Database performance is likely the biggest factor in whether your application is slow or not, and yet too many developers don't take the time to properly understand how their database works. In today's episode, we have A…
Postgres for Search + Analytics with Philippe Noël [not-audio_url] [/not-audio_url]

Duration: 42:39
ParadeDB is Postgres for search and analytics. As Postgres continues to rise in popularity, the "Just Use Postgres'' movement is getting stronger and stronger. Yet there are still things that standard Postgres doesn't do…
AI Agents and Long Context Windows with Mark Huang [not-audio_url] [/not-audio_url]

Duration: 50:24
Today we have Mark Huang on the show. Mark has previously held roles in Data Science and ML at companies like Box and Splunk and is now the co-founder and chief architect of Gradient, an enterprise AI platform to build a…
Vector Databases with Bob van Luijt [not-audio_url] [/not-audio_url]

Duration: 47:19
Today we have Bob van Luijt, the CEO and founder of Weaviate on the show. Bob talks about building AI native applications and what that means, the role a vector database will play in the future of AI applications, and ho…
Akamai: From CDN to Full Cloud Provider with Talia Nassi [not-audio_url] [/not-audio_url]

Duration: 41:48
Today, we have Talia Nassi on the show. Talia’s been leading Developer Advocacy at Akamai. Akamai is in a really interesting space where they've been around for a long time, as a CDN provider, as a security provider, and…
Jamstack and Composable Web Architecture with Brian Rinaldi [not-audio_url] [/not-audio_url]

Duration: 53:59
Today we have Brian Rinaldi from LaunchDarkly on the show. This is the final episode of our in person coverage at the SHIFT Conference in Miami. And although Brian works at LaunchDarkly, we actually didn't talk at all ab…
Practical AI for LLMs with Emanuel Lacić [not-audio_url] [/not-audio_url]

Duration: 51:16
Today we have Emanuel Lacić on the show. He was in academia for a while. Now he’s been working at Infobip for the last couple of years, building some of this AI stuff and putting it into production. We picked his brain a…
Why Building an API for Email is Hard with Christine Spang [not-audio_url] [/not-audio_url]

Duration: 56:33
Today, on the show we have Christine Spang, Co-founder and CTO of Nylas. Christine was the keynote at the recent Shift Developer Conference in Miami, and we caught up with her there. Nylas is a unified API for email, cal…