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
It's time to build Jarvis with Kent C. Dodds [not-audio_url] [/not-audio_url]

Duration: 1:21:17
Today we have the excellent Kent C. Dodds on the program. Kent is an amazing teacher in the web development space, and I've learned a ton from him about React, JavaScript testing, and general web dev. Lately, Kent has be…
Rewriting in Rust + Being a Learning Machine with AJ Stuyvenberg [not-audio_url] [/not-audio_url]

Duration: 1:21:36
Today's guest is AJ Stuyvenberg, a Staff Engineer at Datadog working on their Serverless observability project. He had a great article recently about how they rewrote their AWS Lambda extension in Rust. It's a really int…
Software Reliability Agents with Amal Kiran [not-audio_url] [/not-audio_url]

Duration: 51:07
So if you're writing code or keeping systems running, you probably know the drill. Late night pages, chasing down weird bugs, dealing with alert storms. It's tough! It costs money when things break, and honestly, nobody…
From ORM to Infra: Prisma Postgres with Søren Bramer Schmidt [not-audio_url] [/not-audio_url]

Duration: 1:02:22
Today we have Søren from Prisma on the show. Prisma has been the most popular ORM in the TypeScript world for a while, and now they’re moving more into hosted infrastructure. We spend a lot of time talking about their ne…
Fast Inference with Hassan El Mghari [not-audio_url] [/not-audio_url]

Duration: 53:06
Today we have Hassan back on the show. Hassan was one of our first guests for Huddle when he was working at Vercel, but since then, he's joined Together AI, one of the hottest companies in the world. They just raised a m…
Seattle Startups, AI’s Future & Big Acquisitions with Yujian Tang [not-audio_url] [/not-audio_url]

Duration: 1:02:54
Today on the show, we talked with Yujian Tang. He was on the show previously when he worked at Zilliz, when we talked about vector databases and RAG. He's since branched out on his own, building the tech startup scene in…
Faster & Cheaper on PlanetScale Metal with Sam Lambert [not-audio_url] [/not-audio_url]

Duration: 1:19:43
Today, we have Sam Lambert back on the show! Sam is the CEO of PlanetScale, and if you follow him on X, you know he’s one of the sharpest voices in the database space—cutting through the hype with deep experience and a n…
Redis but Faster With Roman Gershman [not-audio_url] [/not-audio_url]

Duration: 1:00:51
Redis is consistently one of the most beloved pieces of infrastructure for developers. And in the last few years, we've seen a number of new Redis-compatible projects that aim to improve on the core of Redis in some way.…