))
S5E2 Innovative Tool To Keep Docs in Sync with Your Product with Manny Silva
Manage episode 413144925 series 2891683
コンテンツは Zohra Mutabanna によって提供されます。エピソード、グラフィック、ポッドキャストの説明を含むすべてのポッドキャスト コンテンツは、Zohra Mutabanna またはそのポッドキャスト プラットフォーム パートナーによって直接アップロードされ、提供されます。誰かがあなたの著作物をあなたの許可なく使用していると思われる場合は、ここで概説されているプロセスに従うことができますhttps://ja.player.fm/legal。
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 つのエピソード
シェア
