Unit Testing Your Docs | Milecia McGregor | API The Docs Virtual 2020
"Unit Testing Your Docs" by Milecia McGregor, API The Docs Virtual 2020
Talk Description:
"API docs have code snippets in them to help users get through simple and complex problems. Those code snippets are the ones most likely to be broken. In this talk, you’ll learn how to ensure that none of the code in your docs will be out of date & how you can make it part of your deploy cycle.
When you’re focused on getting a bug release shipped, one of the last things you’re thinking about is updating the docs. So the docs get shipped and become out of date with the current version of your API. That’s when users start getting confused and it could take weeks to figure out it’s because they are copying an old example from your documentation.
By including unit tests for all of the code snippets you use, you’re setting yourself up for long-term success with documentation maintenance. It’s no different than writing tests for the APIs and it will save you a lot of time trying to handle user questions. By the time attendees leave this talk, they will know how to implement unit testing into their new or existing docs and how they can deploy them."
API The Docs Virtual 2020 recaps: https://pronovix.com/event/api-docs-virtual-2020
---
API the Docs is an event for tech writers, API developers, product owners and developer evangelists who embrace documentation as a crucial aspect of a great developer experience. The conference is a great opportunity to share and discuss the latest best practices, strategies and new trends relevant to API documentation and developer portals.
Pronovix Developer Portals Newsletter: http://bit.ly/devportals
Что делает видео по-настоящему запоминающимся? Наверное, та самая атмосфера, которая заставляет забыть о времени. Когда вы заходите на RUVIDEO, чтобы посмотреть онлайн «Unit Testing Your Docs | Milecia McGregor | API The Docs Virtual 2020», вы рассчитываете на нечто большее, чем просто загрузку плеера. И мы это понимаем. Контент такого уровня заслуживает того, чтобы его смотрели в HD 1080, без дрожания картинки и бесконечного буферизации.
Честно говоря, Rutube сегодня — это кладезь уникальных находок, которые часто теряются в общем шуме. Мы же вытаскиваем на поверхность самое интересное. Будь то динамичный экшн, глубокий разбор темы от любимого автора или просто уютное видео для настроения — всё это доступно здесь бесплатно и без лишних формальностей. Никаких «заполните анкету, чтобы продолжить». Только вы, ваш экран и качественный поток.
Если вас зацепило это видео, не забудьте взглянуть на похожие материалы в блоке справа. Мы откалибровали наши алгоритмы так, чтобы они подбирали контент не просто «по тегам», а по настроению и смыслу. Ведь в конечном итоге, онлайн-кинотеатр — это не склад файлов, а место, где каждый вечер можно найти свою историю. Приятного вам отдыха на RUVIDEO!
Видео взято из открытых источников Rutube. Если вы правообладатель, обратитесь к первоисточнику.