Ранее возникала мысль оставить небольшую заметку на эту тему, но думал, что не очень она интересная. Однако произошедший на днях случай буквально заставил меня “взяться за перо”.

Дело было так.

Предложили мне ознакомиться с имеющимся материалом для дальнейшей разработки технической документации, в частности, руководства администратора. Но как затем выяснилось, “документ” должен быть выполнен не в текстовом виде, а состоять из набора скринкастов.

“Да кому интересны тонны макулатуры? Сейчас почти все видюшки смотрят…” (лексика сохранена).

Здесь также важно отметить, что эти слова были сказаны человеком далёким от разработки и администрирования информационных систем. Если бы при обсуждении задачи присутствовал представитель “технарей”, скорее всего, потребовалось бы гораздо меньше времени на аргументацию моей позиции.

Итак, что же такое скринкасты и почему я не являюсь сторонником подобного вида “упаковки” технической документации?

Начну с того, что скринкаст (screencast) - это видеоролик, записанный с монитора компьютера с помощью специального программного обеспечения. То есть записываются действия, выполняемые “оператором” на компьютере. Довольно часто в процессе записи также добавляется голосовое сопровождение. Да, не поспоришь, это очень популярное нынче направление и оно прекрасно подходит для решения определённых задач. Например, демонстрация возможностей продукта, короткие обучающие или how-to ролики, ответы на часто задаваемые вопросы и т.д.

Но если речь заходит о таких документах, как руководства разработчиков или администраторов, то старый-добрый текстовый формат может быть единственно приемлемым. Моё личное мнение. Скринкасты не подходят для замены документации. Будем честны, разработчики и администраторы, да и все остальные “айти-парни” очень ленивые и не любят тратить своё время попусту. Они предпочитают быстро найти ответ на возникший вопрос, чтобы поскорее решить задачу. Длинные текстовые документы (с сопровождающими скриншотами) без интерактивной навигации и с возможностью поиска (ctrl+f) по контенту - наиболее удобный для этой цели вариант. Было возражение, что можно использовать таймкоды в скринкастах. Но практика показывает, что и это не помогает. Всё равно приходится просмотреть какую-то часть ролика, а это опять же лишнее время “ленивых парней”.

Выводы следующие:

  1. Скринкасты - отличный и нужный формат для демонстрации продукта и небольших how-to роликов.
  2. Скринкасты не подходят в качестве замены документации разработчиков/администраторов.
  3. Простые текстовые форматы на сегодняшний день являются единственно приемлемыми в качестве документации разработчиков/администраторов.