Do I need to know coding to do API documentation?
Subscribe to The Content Gym newsletter for much such posts: https://www.linkedin.com/newsletters/the-content-gym-6930022180889972736
Video Chapters
--------------------------------------------
0:00 Welcome - this question has been popping in a lot of TW forums
0:49 What the question should really be phrased as:
2:36 API Docs - REST API Docs - What's the difference?
3:20 API Docs - Examples
3:33 Oxygen API Docs
4:33 MadCap Flare Plugins API Docs
5:18 Transpose function in the Pandas library of Python
6:17 REST API Docs Example - Google Directions API
7:30 Making a google directions API call using Postman
8:40 Generating the python code for making the google directions API call
13:07 Coding is not that difficult
13:15 Java and C++ scared us
15:00 Explore a bit of Python to get over the programming learning trauma
16:11 A highly recommended programming course - starts with absolute basics
17:23 Reading Code is simple - but there are other challenges to surpass in doing REST API Docs
19:16 Not all REST API Technical Writers are doing the same kind of work
20:01 YAML \ Swagger Editor hands on - Docs as code
21:46 The best kind of REST API Docs work
23:04 Code writing skills come with their own set of problems - no patience to explain
24:22 Things you need to know to do REST API Documentation
25:40 Conclusion - REST API Docs space needs you - even if you are not a programmer
27:14 Subscribe to The Content Gym newsletter for further, more detailed learning on REST API Docs
Presentation: https://github.com/TheContentGym/CodingForAPIDocs/blob/main/Do_I_need_to_know_coding_to_document_the_APIs_.pdf (download the PDF to access the links)
Что делает видео по-настоящему запоминающимся? Наверное, та самая атмосфера, которая заставляет забыть о времени. Когда вы заходите на RUVIDEO, чтобы посмотреть онлайн «Do I need to know coding to do API documentation?», вы рассчитываете на нечто большее, чем просто загрузку плеера. И мы это понимаем. Контент такого уровня заслуживает того, чтобы его смотрели в HD 1080, без дрожания картинки и бесконечного буферизации.
Честно говоря, Rutube сегодня — это кладезь уникальных находок, которые часто теряются в общем шуме. Мы же вытаскиваем на поверхность самое интересное. Будь то динамичный экшн, глубокий разбор темы от любимого автора или просто уютное видео для настроения — всё это доступно здесь бесплатно и без лишних формальностей. Никаких «заполните анкету, чтобы продолжить». Только вы, ваш экран и качественный поток.
Если вас зацепило это видео, не забудьте взглянуть на похожие материалы в блоке справа. Мы откалибровали наши алгоритмы так, чтобы они подбирали контент не просто «по тегам», а по настроению и смыслу. Ведь в конечном итоге, онлайн-кинотеатр — это не склад файлов, а место, где каждый вечер можно найти свою историю. Приятного вам отдыха на RUVIDEO!
Видео взято из открытых источников Rutube. Если вы правообладатель, обратитесь к первоисточнику.