با برنامه Player FM !
پادکست هایی که ارزش شنیدن دارند
حمایت شده
S5E2 Innovative Tool To Keep Docs in Sync with Your Product with Manny Silva
Manage episode 413144925 series 2891683
As technical communicators, this challenge most likely resonates with you -- how do you keep docs in sync with your product? In the words of Manny Silva, "When product updates are frequent and user expectations are high, maintaining accurate and up-to-date documentation isn’t just a necessity—it’s a competitive advantage."
Manny proposes. Docs as Tests, a strategy that keeps your docs in sync with your product. It’s a way to test your docs, just like engineers test their code.
As Manny joins me, we unravel the story of Doc Detective—an innovative tool that challenges the status quo by ensuring documentation remains in lockstep with product functionality. Through a case study and demo, Manny shares how Doc Detective tests your content against your product UIs and APIs to ensure that your docs are always accurate, complete, and relevant.
Where can you view the demo?
View the demo (24:04 to 34:24) at this link.
Resources
- Docs as Tests blog
- Doc Detective Github (open to contributions!)
- Doc Detective documentation (open to contributions!)
- Doc Detective Discord channel (for questions and contributors)
Events to attend where Manny will be presenting in 2024
Guest Bio
A tech writer by day and engineer by night, Manny Silva is Head of Docs at Skyflow, codifier of Docs as Tests, and the creator of Doc Detective. He’s passionate about intuitive and scalable developer experiences and likes diving into the deep end as the 0th developer.
Show Credits
- Intro and outro music - Az
- Audio engineer - RJ Basilio
فصل ها
1. S5E2 Innovative Tool To Keep Docs in Sync with Your Product with Manny Silva (00:00:00)
2. Elevating Tech Writing With Documentation Tests (00:00:04)
3. Benefits of Open Source Doc Detective (00:15:58)
4. Doc Detective Testing and Demo (00:20:10)
5. Benefits of DocDetective for Documentation (00:33:26)
6. Knowledge Sharing Podcast Interview (00:45:29)
49 قسمت
Manage episode 413144925 series 2891683
As technical communicators, this challenge most likely resonates with you -- how do you keep docs in sync with your product? In the words of Manny Silva, "When product updates are frequent and user expectations are high, maintaining accurate and up-to-date documentation isn’t just a necessity—it’s a competitive advantage."
Manny proposes. Docs as Tests, a strategy that keeps your docs in sync with your product. It’s a way to test your docs, just like engineers test their code.
As Manny joins me, we unravel the story of Doc Detective—an innovative tool that challenges the status quo by ensuring documentation remains in lockstep with product functionality. Through a case study and demo, Manny shares how Doc Detective tests your content against your product UIs and APIs to ensure that your docs are always accurate, complete, and relevant.
Where can you view the demo?
View the demo (24:04 to 34:24) at this link.
Resources
- Docs as Tests blog
- Doc Detective Github (open to contributions!)
- Doc Detective documentation (open to contributions!)
- Doc Detective Discord channel (for questions and contributors)
Events to attend where Manny will be presenting in 2024
Guest Bio
A tech writer by day and engineer by night, Manny Silva is Head of Docs at Skyflow, codifier of Docs as Tests, and the creator of Doc Detective. He’s passionate about intuitive and scalable developer experiences and likes diving into the deep end as the 0th developer.
Show Credits
- Intro and outro music - Az
- Audio engineer - RJ Basilio
فصل ها
1. S5E2 Innovative Tool To Keep Docs in Sync with Your Product with Manny Silva (00:00:00)
2. Elevating Tech Writing With Documentation Tests (00:00:04)
3. Benefits of Open Source Doc Detective (00:15:58)
4. Doc Detective Testing and Demo (00:20:10)
5. Benefits of DocDetective for Documentation (00:33:26)
6. Knowledge Sharing Podcast Interview (00:45:29)
49 قسمت
همه قسمت ها
×


1 S5E8 Reimagining a Unified Content Experience for Customer Success with Scott Abel 1:05:09



1 S5E5 Mastering AI-enhanced Content Creation using Retrieval-Augmented Generation (RAG) with Manny Silva 51:06









1 S4E7 Bridging the Gap: How AI is Reshaping Technical Communication with Ryan Boettger 1:01:36






1 S3E9 Smart Strategies for Saving Costs with Machine Translation and Going Global with Lisa Zarfl 36:27

1 S3E8 Through the Lens of a Scrum Master - Speak Up and Advocate for Yourself with Jennifer Savage 31:38


1 S3E6: Embrace Discomfort and Challenge the Status Quo for Advocacy and Visibility with Swapnil Ogale 55:06

1 S3E5 Delighting Your Customers - How to Craft Meaningful UX as a Content Developer with Ellyn Hassell 1:03:17

1 S3E4 Through the Lens of QA and Project Management - Discussion on Why Writers Matter! with Tejasvi Patil 42:34

1 S3E3 Through the Lens of a Product Manager - Discussion on Why Writers Matter! with Bill Glynn 48:56




1 S2E5 Tips to Sharpen your Job-Searching Skills: Gems from a Recruiter with Olivia Farmer 1:07:11













به Player FM خوش آمدید!
Player FM در سراسر وب را برای یافتن پادکست های با کیفیت اسکن می کند تا همین الان لذت ببرید. این بهترین برنامه ی پادکست است که در اندروید، آیفون و وب کار می کند. ثبت نام کنید تا اشتراک های شما در بین دستگاه های مختلف همگام سازی شود.