Найти тему
46 подписчиков

Задачи технического писателя. Часть 1


В этом и следующих постах расскажу о рутинных рабочих задачах технического писателя😉

Важная часть работы технического писателя — конспектирование созвонов с разработчиками.

Такой немного забытый навык со времен универа))

Это бывает необходимо по ряду причин. Например, доступов к нужному сервису у тебя еще нет, а начать его описание уже нужно.

Либо сервис еще находится в разработке, и тебе нужно структурировать имеющиеся у разработчика знания о нем, чтобы в лаконичной форме презентовать коллегам из других команд, например, UI дизайнерам.

На помощь приходит созвон в Зум — разработчик шарит свой экран и рассказывает, что за сервис он делает/сделал, и для чего он нужен. Обычно такие звонки назначает проджект-менеджер, но иногда приходится договариваться и самому.

А ты потом пересматриваешь это видео и кропотливо переносишь в текст информацию и добавляешь скриншоты.

На выходе получается уже вполне себе сносный черновик описания сервиса.

А пригодится он может в том числе и новым членам команды, которым нужно как можно быстрее влиться в тему. Чтобы не тратить время на просмотр двух часовых созвонов)

Ну и главный плюс — раз за разом слушая и записываю инфу о сервисе, начинаешь понимать его суть.

А это облегчает общее понимание механизмов работы.

Например, если несколько раз законспектировать разные созвоны, где объясняют, что из себя представляет тот или иной сервис, то будь таких сервисов хоть 100 штук — структура и дефолтные настройки будут примерно одинаковыми. И ты уже будешь в них как рыба в воде)

В общем, если хотите разобраться в какой-либо теме, навык создания адекватных конспектов пригодится и в реальной жизни практически в любой сфере👌
1 минута