О, кстати, про автозапись

Сам ролик записать можно из UI-тестов, тут ещё +- понятно. А вот звук сводить, неужели только руками или самопальными скриптами? Кто-нибудь практикует?

мы пока пробуем руками подгонять длительности таймаутов с amazon polly

это видится как задача редкая. Один раз сделал, потом только корректируешь.

А нужен ли звук? Он дорогой и accessibility не очень. Я бы делал субтитры, свои (не автоматические), с переводами, нативными инструментами Ютуба.

Ну или врезать их в короткие видео, если у нас не ютуб, а HTML5

Если это озвучка гайда по использованию инструмента, бывает удобно включить фоном и самому начать протыкивать то, что озвучивает диктор

Но ты ж тогда не видишь экран с демонстрацией. Тебе удобно так?

Зависит от текста озвучки и общей "понятности" UI

У какой-то CRM натыкался на очень хорошо озвученные гайды, где я реально их фоном слушая быстро нашёл всё

Вот не помню, FreshSales или Pipedrive это был

Я ролики делаю, уже больше чем с текстом работаю, озвучка роботом, съемка и монтаж в камтазии, думаю в адобе премьер переходить для более привлекательной картинки, изучаю потихоньку

Коллеги, привет! Расскажите, кто-то использует инструменты для документирования кода JavaScript, Typescript, например, JSDoc, TSDoc?

Полные обучающие ролики - Camtasia + youtube. Но очень нравится, когда прямо в документацию встраивают видеофрагмент - иногда спасает при накрученном интерфейсе. Сама видофрагменты в документацию ещё не включала, но планирую. Когда-нибудь )

Про это может знать @vadkou

Зависит от того, что именно хочется задокументировать

1. Если речь про UI, полезнее всего визуальная документация, вроде Storybook, Styleguidist, Docz.
2. Логика - немного JSDoc и мб юнит-тесты.
3. Модель данных - сам по себе TypeScript и есть своего рода документация модели, разве что поля JSDoc'ом объяснить (если, конечно, это уже в серверной спеке не сделано, тогда смысла дублировать доку не вижу)
4. Архитектурные решения - вообще не в коде, для этого лучше отдельно док написать.

Что в итоге хочется получить от такой документации?

Вадим, у меня п. 2. Описываю методы апи: что он делает, какие параметры могут быть.

Так приходится разработчика выпытывать. А если бы комментарии были в коде, то все это было бы быстрее.

Прочитал статью, где TypeDoc справляется с этой задачей.

А почему серверные методы документируются на клиенте (вижу на скрине Vue), а не на сервере?
Или про какое API мы говорим?

Не понял вопрос. Этот код лежит в репозитории. Апи для Vue

Что такое API для Vue?
Вы библиотеку делаете и хотите задокументировать её интерфейсы?