Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза.
Действующие лица
Фёдор — младший технический писатель, главный герой истории.
Команда технических писателей, которые вместе с Федей пишут документацию по релизу.
Ведущий технический писатель — ответственный за выпуск релиза документации. Всех торопит и всем помогает.
Технический редактор — проверяет документацию, находит ошибки, строго контролирует соблюдение руководства по стилю.
Аналитики, разработчики, тестировщики, преподаватели — dreamteam, носители знаний, которые не жалеют времени на проверку и улучшение документации.
09:02. Setup
Федя сразу включается в работу — дел много, нужно всё успеть. Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Поехали!
Для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Очень много изменений за вчерашний день. Хорошо, что нет конфликтов — каждый работает на своём строго отведённом участке, у каждого свой набор разделов в общем документе.
Федя часто мысленно представляет свою команду как настоящую профессиональную редакцию какой-нибудь газеты — знаете, как в старых фильмах. Там кипит работа, стоит шум и гам.
Журналисты-писатели, правда, находятся в разных городах и разных часовых поясах, но несмотря на это, кажется, что все сотрудники находятся в одной большой комнате — редакции. Отовсюду слышатся телефонные звонки, стучат клавиши, слышны обрывки разговоров. Весь этот шум перекрывает строгий голос главного редактора, который распекает одного из журналистов за некорректные формулировки в его черновике.
Сегодня вечером номер нужно сдать в печать — времени остаётся всё меньше, а сделать нужно ещё очень много. Каждый работает над своей статьёй, но все вместе они делают одну общую газету. Точно так же каждый писатель работает над своими разделами, которые войдут в общий документ.
09:15. Время правок
В этот раз Федя описывает настройки нового решения в двух системах. Работа уже почти готова, все нужные разделы написаны. Но, как назло, перед самой отгрузкой приходится вносить правки.
Вчера, уже в самом конце рабочего дня, пришли письма с правками от аналитика и разработчика. Федя успел их бегло просмотреть — вроде ничего критичного. Но правок много, нужно их все аккуратно учесть в тексте. В какой-то таблице добавилась пара новых полей. Где-то нужно уточнить условия запуска процедуры. А ещё в нескольких местах нужно добавить примечание в алгоритм.
И Фёдор сосредоточенно принимается за работу — главное, ничего не пропустить и не забыть.
10:48. Напряжение растёт
Ведущий писатель уже нервничает. В релизе он — главный ответственный «выпускающий редактор». Ему сегодня отгружать документацию — отправлять номер в типографию. В общем чате появляется сообщение с вежливым и сдержанным (пока сдержанным!) напоминанием о том, что неплохо бы в этот раз в виде исключения отгрузиться не в 23:59, а желательно немного пораньше.
12:15. Первый конфликт
Федя почти закончил внесение правок: осталось дополнить несколько общих разделов. Тут сложнее. Это что-то вроде первой газетной полосы — самое горячее место. В день релиза исходники текста этих разделов нарасхват.
Сначала Федя загружает свежие версии исходников нужных разделов из репозитория и чинно сообщает в общем чате, что ненадолго забирает их себе для редактирования. Спокойно вносит свои правки и пытается закоммитить их обратно на сервер. Красные стрелки красноречиво говорят о том, что кто-то из писателей его опередил. Конфликт версий!
Атмосфера в редакции понемногу начинает закипать. Пара кликов мыши, и Фёдор выясняет, кто там такой шустрый. Спокойствие, только спокойствие, сегодня у всех цейтнот. Пять минут переписки, и проблема решена — небольшое техническое недоразумение. Приходится потратить ещё некоторое время на «мёрдж», но в итоге получается красивый и актуальный раздел. Федя торжественно выгружает результат в репозиторий.
13:31. Перезагрузка
Пора подкрепиться. За первые месяцы работы Фёдор усвоил один важный урок: мозг без питания и отдыха работает плохо. А ведь это — важнейший инструмент писателя. Каждый несъеденный апельсин, как известно, увеличивает вероятность ошибок в тексте. Пускай шумная редакция немного подождёт — писателю нужно отдохнуть, пообщаться с котами и основательно перекусить.
14:40. Визуализация
После обеда Федю ожидает сюрприз. В общем чате — сообщение от технического редактора. Он забрал на проверку несколько новых разделов. В том числе и те, с которыми работает Федя. Это значит, что их пока изменять нельзя. Не страшно, как раз самое время немного порисовать.
Алгоритмы поменялись, текст уже переписан, но нужно переделать диаграммы последовательности. Раньше Фёдор потратил бы на это пару часов — пришлось бы сосредоточенно рисовать новые стрелочки в графическом редакторе. Теперь у него есть PlantUML — достаточно переписать несколько строк в текстовом исходнике. Наш Федя быстро справляется с этой задачей. Сохраняем файл, запускаем скрипт, получаем SVG-диаграмму. Готово!
15:02. Промежуточный контроль
Напряжение в чате растёт. Ведущий писатель опрашивает каждого лично — что уже сделано и, самое главное, что ещё не готово. У всех всё по-разному. Кто-то радостно рапортует о том, что «осталось совсем чуть-чуть». Кто-то сердито бурчит: «Всё в процессе, работы ведутся».
Фёдор отчитывается, что ждёт правок технического редактора. Не он один такой. Ведущий писатель ушёл к техническому редактору. Федя представляет себе сцену под названием «Взъерошенный главный редактор экспрессивно беседует с редактором техническим».
15:32. Назойливые описки
Редактор, как всегда, отработал быстро и чётко. В чате появляется его лаконичное сообщение о том, что всё готово. Писатели потянулись в репозиторий — загружать свои файлы с правками.
Федя загружает исходники своих разделов. Интересно, что там нашёл редактор? Пара дурацких описок, а ещё в нескольких местах Федя забыл поставить запятые. Мелочи — это всё легко и быстро поправить.
А описки — это вообще неистребимое зло. Пишешь текст, думаешь, как лучше сформулировать предложения, попроще объяснить читателю сложную концепцию. И случайно пропускаешь ляпы, вроде «оглашение» вместо «соглашение» или «пекат» вместо «пакет». И ведь проверка орфографии их не видит! Есть такие слова в словаре. Но зато их видит редактор.
16:28. Промежуточная готовность
Фёдор ещё раз всё внимательно проверяет. Запускает скрипт проверки корректности формата. Вроде всё в порядке — ошибок в форматировании и разметке нет. Теперь нужно запустить сборку всего документа. Пока тулкит собирает PDF-файл, Федя смотрит, что там у других. Похоже, многие уже тоже почти готовы. Ведущий писатель может выдохнуть — номер уйдёт в печать, читатели получат свежие документы.
После всех проверок Федя выгружает все исходники в репозиторий и торжественно пишет в чате: «Готов ?». Вслед за ним постепенно все другие писатели начинают сообщать о готовности своих частей.
18:15. Release
Номер уходит в типографию. Ведущий писатель торжественно запускает процесс сборки и отгрузки. Прессы приходят в движение, вращаются огромные бобины чистой бумаги. Свежие, только что отпечатанные номера несутся по конвейеру — прямиком к подписчикам. PDF-файлы отгружены, уведомления заказчикам ушли. Теперь они могут зайти на сайт и скачать себе новые документы.
В чате ликование — они все вместе закончили большую, сложную работу. Все поздравляют друг друга с отгрузкой. Рабочий день подходит к концу.
Над рабочим столом у Феди висит распечатка с замечательной цитатой из Шерлока Холмса: «Мой мозг, подобно перегретому мотору, разлетается на куски, когда не подключён к работе, для которой создан». Мозг технического писателя — мощный мотор, который настроен на постоянную переработку огромных потоков информации.
Завтра будут новые задачи, новые документы. Но Фёдор не грустит по этому поводу, он просто любит свою работу. Ведь разбираться с новыми системами, алгоритмами, функциями, пропускать всё это через свой разум, систематизировать, структурировать и в конце концов описывать простыми и понятными словами — это очень интересно. Всё равно, что для математика — решать необычные трудные задачи, для физика — исследовать окружающий мир, а для инженера — конструировать новый полезный механизм. Профессия технического писателя позволяет совмещать творчество и анализ с созданием новых полезных артефактов — документов, которые будут читать пользователи.
Скрытый текст
Если вам тоже нравится решать сложные интересные задачи и писать понятные тексты, то вам может подойти работа технического писателя. Например, в команде технических писателей компании Bercut. А в отделе у Феди сейчас вакансий нет... :)
Ещё почитать: