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
Enterprise-grade Dev Environments with Ivan Burazin [not-audio_url] [/not-audio_url]

Duration: 51:33
Today’s guest is Ivan Burazin, the co-founder and CEO of Daytona, an actual creator of the Shift Developer Conference that he sold some time ago to Infobip. Ivan has tons of experience building developer tools, he has be…
Operational Data Warehouse with Nikhil Benesch [not-audio_url] [/not-audio_url]

Duration: 1:05:56
Today's episode is with Nikhil Benesch, who's the co-founder and CTO at Materialize, an Operational Data Warehouse. Materialize gets you the best of both worlds, combining the capabilities of your data warehouse with the…
Multi-tenancy with Khawaja Shams [not-audio_url] [/not-audio_url]

Duration: 1:09:04
Today's episode is with Khawaja Shams. Khawaja is the CEO and co-founder of Momento, which is a Serverless Cache. He used to lead the DynamoDB team at AWS and now he's doing Memento. We talk about a lot of different thin…
All about Rust with Tim McNamara [not-audio_url] [/not-audio_url]

Duration: 1:51:56
In today's episode with Tim McNamara, we talk all about Rust. Tim is one of the leading educators in the whole Rust educational space. He wrote the Rust in Action book, which is probably the best Rust book out there. He…
Becoming an Epic Web Developer with Kent C Dodds [not-audio_url] [/not-audio_url]

Duration: 55:39
Today, we have Kent C Dodds on the show. If you don't know Kent, he's a well known expert in JavaScript, Web Development and Teaching. His courses like Testing JavaScript, Epic React, and Epic Web Dev have helped countle…
SQL Meets Vector Search with Linpeng Tang of MyScale [not-audio_url] [/not-audio_url]

Duration: 1:01:38
Welcome back to an episode where we're talking Vectors, Vector Databases, and AI with Linpeng Tang, CTO and co-founder of MyScale. MyScale is a super interesting technology. They're combining the best of OLAP databases w…
What is a Vector Database with Yujian Tang [not-audio_url] [/not-audio_url]

Duration: 50:44
Today's guest is Yujian Tang from Zilliz, one of the big players in the vector database market. This is the first episode in a series of episodes we’re doing on vectors and vector databases. We start with the basics, wha…
Serverless Clickhouse with Tyler Wells [not-audio_url] [/not-audio_url]

Duration: 1:12:12
Today's episode is with Tyler Wells. Tyler is the CTO and co-founder at Propel. He was an early employee at Skype (and Microsoft after the acquisition) as well as Twilio. While at Twilio, Tyler helped build a data platfo…
Elasticsearch Fundamentals with Philipp Krenn [not-audio_url] [/not-audio_url]

Duration: 1:20:09
Today, we have Philipp Krenn on the show. He's the head of DevRel for Elastic, and we took a deep dive on all the Elasticsearch stuff like Indexes, Mappings, Shards and Replicas and how to think about performance and all…
Building a Better C with Loris Cro from Zig Software Foundation [not-audio_url] [/not-audio_url]

Duration: 1:10:25
Zig is a new programming language with big ambitions: to be a better C. Loris Cro is the VP of Community at the Zig Software Foundation, and he takes us through the ins and outs of Zig -- how was it created, what problem…