Нужно ли писать документацию быстро (или быстрее, чем привычно?), а, главное, зачем? На одном из профильных каналов увидела список лайфхаков, как это можно сделать. Актуально для айтишников. Но если переложить их советы для тех кто пишет по ГОСТ... Итак, поехали!

1️⃣ Пишите для себя в будущем

Если в IT актуальны автоматизация процессов и работа с целевой аудиторией, то у "гостовиков" техписатель обычно не влияет на автоматизацию, а целевая аудитория - это заказчик, который прописывает конкретные цели в техническом задании. Конечно, в рамках жизненного цикла и последующей эксплуатации изделия некоторые параметры могут быть откорректированы, но на конечные характеристики они никак не должны повлиять - иначе вводится новое исполнение.

Итак, что же тогда подразумевается под "писать для себя в будущем", будь то ПС, РЭ, ТУ, ФО и т. д.? Раскроем это в последующих советах.

2️⃣ Используйте шаблоны

Как правило, если процесс работы над документацией отлажен, то шаблоны в виде рамок, таблиц определенной формы и размеров уже существуют, а также последовательностью изложения информации. Дополнительно можно взять готовый редактируемый документ, принятый всеми инстанциями, пересохранить и откорректировать под себя. Использование ИИ не допускается. Готовые шаблоны значительно ускоряют создание документации.

А в ситуации, когда документ на предприятии выпускается впервые, либо техническая документация изначально выпускается с нуля, некоторое время придется потратить на то, чтобы довести документ до ума, или, точнее, до полного соответствия текущей версии ГОСТ.

Продолжение 23.12.2025

3️⃣ Ускорьте создание текста

В профильном канале совет звучит так: В инструкциях используйте пирамиду Минто: изложите сначала главную мысль или цель, для чего нужны последующие действия, а затем излагайте их. Такой метод подходит для большинства типов документации. Придерживайтесь его, и вы потратите гораздо меньше времени на раздумья. А для написания текста настройте инструменты ускоренного ввода, например сниппеты для VS Code, и используйте горячие клавиши.

Не знаю, используется ли Docs as Code для оформления документации по ГОСТ (у нас точно нет). Поделюсь личным опытом: обычно иду либо от понятного к непонятному, то есть, работаю с даными, которые мне передали разработчики и оформляю разделы, которым они соответствуют. Либо сначала иду на испытательный стенд, подключаю к нему изделие и проверяю, насколько верно мне дали информацию, при необходимости уточняю и корректирую и лишь затем сажусь за написание документа.

4️⃣ Автоматизируйте всё, что можно автоматизировать

Как я и говорила чуть выше, нейрогенерация у нас категорически не допускается. Но у нас допускается небольшая автоматизация в виде макросов, которые настраивают название раздела, дату, номер страницы и т. д. При работе с РЭ по ГОСТ 18675-12 автоматизация внешнего вида документа происходит за счет специальной программы.

5️⃣ Настройте проверки

В IT сфере допустимо использовать разные спеллчекеры - компьютерные программы, проверяющие текст на орфорграфические и пунктуационные ошибки. А я даже не могу сделать через сервисы, которые применяю в копирайтинге.Только ручками и глазками. Но у меня есть свой собственный чек-лист, который включает себя проверку документа по определенным словам и критериям. Поделиться пока не могу, потому что для каждого документа свой индивидульный подход, в связи с которым чек-лист рождается прямо на ходу

Продолжение 24.12.2025

А теперь пытаюсь ответить на второй вопрос: зачем писать документацию быстрее? С одной стороны, причины очевидны: сроки, определяемые заказчиком и юридически значимой сопутствующей документацией, KPI. Надо учесть, что техпис никогда не работает один: его "писанину" должны посмотреть метролог, нормоконтролер и так далее. Если же нет "давящих сроков", то, честно говоря, не вижу ни одной причины писать быстрее. Техпис (на мой взгляд) - это в первую очередь мыслитель (нужно сначала переварить информацию, переданную разработчиками) и лишь затем писака. И если на мыслительный процесс излишне давить, то на выходе документ получится "не очень". Возможно, у вас другое мнение - напишите в комментариях.

Два пилота из США и Канады нарисовали Гринча в небе своими самолётами. Первый за 2,5 часа изобразил похитителя Рождества рядом с канадским Гоффсом на Cirrus SR22. Второй за три часа воссоздал крадущуюся фигуру над Огайо на винтажном Piper PA-28 1965 года.

У всех сейчас настроение "давайте перенесем это на следующий год"? У кого мечты совпали с реальностью? У меня нет, буду работать до конца, но отношусь к этому совершенно спокойно. Все же, чем больше сделаю в этом году, тем меньше буду делать в следующем. ☝️

Пролетел 2025 год, наполненный весьма неожиданными для меня событиями. Остались последние рабочие деньки - 29 и 30 декабря. Я не подвожу итоги специально к 1 января, не строю никаких грандиозных планов. С 12 января выхожу 5/2. На днях подсчитала и ужаснулась: в течение 2025 года я на удаленках совокупно провела 3,5 месяца, на официальном больничном 2 недели, в отпусках - 22 дня (остальные дни перенесла на будущее) + дни, когда отпрашивалась - по разным причинам. Итого меня физически не было на работе примерно 5 😱😱😱месяцев. Спасибо руководителям за то, во многом пошли мне навстречу и коллегам за частичную помощь в моих трудовых обязанностях, которые не могла выполнять из-за невозможности физически присутствовать на работе.

Я встала на очередь на операцию в одно солидное лечебное учреждение, жду вызов в следующем году (в каком месяце - не знаю). Вроде и диагноз не страшный, и операция прогрессивная (я про нее прочитала, наверное, на 20 разных сайтах, если не больше), и перспективы на будущее хорошие, а все равно несколько волнительно. Однако диагноз не помешает кататься на работу и обратно на велосипеде до начала операции, а после велосезон на 2026 год для меня закончится. Так что в следующем году ожидаю, что уйду на больничный, а с него - на удаленку (вот такой я работоголик!) на некоторый период.

Самое интересное, что за период вынужденной удаленки были не только эмоции (а их было ой как много, это сейчас я уже в последней стадии принятия новой реальности), но и чудеса там, где их не ждала. Они выражались в том, что со мной случались абсолютно нетипичные события, в результате которых я получала мощную поддержку от людей, которых видела в первый и последний раз в жизни.

Несколько раз порывалась написать пост в стиле "пожалейте меня" и тут же стирала его, так как категорически не хотела (и сейчас не хочу), чтобы меня жалели. Я долго раздумывала, писать об операции сейчас или сделать это по факту нахождения в стационаре, но интуиция подсказывает, что лучше сейчас.

Я прощаюсь с 2025 годом со смешанными чувствами. С одной стороны, дикая усталость и вселенская грусть, с другой - тихая радость, для которой, к счастью, есть основания. У меня нет того новогоднего настроения, которое нам усиленно пропагандируют из всех утюгов. Но есть свое собственное, с которым хочу провести этот Новый Год и последующие праздничные дни.

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

Но! Слушать тишину и крики чаек среди нее. Настроиться на один ритм с Финским заливом. Говорить на одном языке с шелестом ветра и шорохами природы. Список "не" и "но" можно продолжать бесконечно.

Я по жизни никогда не жду чудес, не прошу и их ни от Бога, ни от судьбы, но что-то подсказывает, что самое интересное еще впереди.

PS Сегодня последний день моей внутренней мобилизованности, то есть, готовности принять звонок или сообщение по работе. 29 и 30 декабря я должна была по графику идти в отпуск, от которого в итоге отказалась, но нисколько не жалею об этом. А с завтрашнего дня я буду полностью отключаться от своих экстремально насыщенных ранее будней, в том числе, на некоторое время полностью сменю обстановку (но буду в пределах Санкт-Петербурга и области).

Поздравляю всех читателей и подписчиков с Новым Годом и Рождеством Христовым! Желаю, чтобы 2026 год стал яркой и доброй личной историей, где сюжетные линии обязательно приведут к заветным мечтам и целям.

У каждого из нас уже есть примерное понимание насчет того, какие события должны произойти в будущем. Пусть все случится самым благоприятным образом для вас!

До встречи 12.01.2026

Всех с первым рабочим днем! С одной стороны, я очень ждала выхода на работу, с другой - очень боялась проспать, что и случилось 😊. Сейчас смотрю на рабочую обстановку так, словно пришла впервые. Потому сегодня "ознакомительный" день: вспоминаю, что, где, как, а когда - напоминают коллеги 😊.

А как у вас проходит первый рабочий день 2026 года?

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

PSS Хочу. Обнять. Котеночка. Который теперь скучает дома. 😺

Попытка восстановить режим дня. Сегодня уровень: не опоздала на работу, на этом спасибо ✈️🤣

PS А если серьезно, это подлет к г. Улан-Удэ

Облака, солнце и гора Эльбрус ⛰

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

Прикол в интернете уже старый, по сути, баян. Но в работе иногда так и получается, что пишешь вроде про лося, а по факту про гуся. У вас так бывает?

✈️ ATIS: «Погодная сводка» для пилотов

Каждый раз, готовясь к посадке или вылету аэропорта, пилоты в первую очередь слушают безэмоциональный голос автоответчика. Это ATIS —
ATIS (Automatic Terminal Information Service) — автоматическая информация в районе аэропорта. Это непрерывно транслируемое аудиосообщение, содержащее актуальные метеоусловия, данные о рабочей ВПП, особые указания и другую информацию для экипажей.

Из чего состоит «бутерброд» ATIS? Расшифруем на примере:

Допустим, вы слышите: «Информация Альфа, 1800Z...»

1. Идентификатор: Буква (Alfa, Bravo, Charlie...). Ключевой элемент! Показывает, какая по счёту это сводка.
2. Время наблюдения: Координированное всемирное время (Zulu time). Например, 1800Z.
3. ВПП в использовании: ВПП 24L. Пилоты сразу понимают, на какую полосу предстоит посадка.
4. Ветер: Ветер 240 градусов, 10 узлов, порывы 15. Важно для расчёта посадки и выбора ВПП.
5. Видимость: Видимость 10 километров или, наоборот, 400 метров в дожде.
6. Облачность: Небо ясно или Сплошная облачность 300 метров. Критично для захода на посадку.
7. Температура/точка росы: Температура 15, точка росы 12. Помогает предсказать возможность обледенения или тумана.
8. Давление (QNH/QFE): QNH 1013 гектопаскалей. Пилоты выставляют по нему высотомер, чтобы точно знать высоту до земли.
9. Особые указания: Может быть информация об обледенении, закрытых рулежных дорожках, работе курсо-глиссадной системы (ILS) и т.д.
10. Кодовое слово: В конце звучит та же буква, что и в начале: «Сообщите о получении информации Альфа». Это подтверждение диспетчеру, что пилот работает с актуальными данными.
Как и как часто её предоставляют?

· Кто: Запись делает диспетчер-метеоролог или сам диспетчер подхода/руления на основе данных метеодатчиков и наблюдений.
· Как: Голосовое сообщение записывается и зацикливается на отдельной радиочастоте ATIS.
· Частота обновления: Ключевой принцип — при каждом существенном изменении погоды или конфигурации аэропорта.
· Обычно это происходит каждые час, если изменения незначительны.
· При быстром ухудшении или улучшении погоды (смена ВПП, видимости, ветра) новая сводка выпускается немедленно.
· Каждое новое сообщение получает следующую букву алфавита (после Zulu снова Alfa).

Зачем это нужно?

1. Снижает нагрузку на диспетчеров: Пилоты прилетают уже «подготовленными». Диспетчеру достаточно сказать: «Добро пожаловать, информация Дельта актуальна».
2. Повышает безопасность: Все экипажи в зоне аэропорта работают с одной и той же актуальной информацией.
3. Структурирует процесс: Стандартный формат сводки позволяет пилотам быстро находить нужные данные, даже на иностранном языке.

Так что, услышав в фильме в кабине пилотов размеренный голос, диктующий цифры, — теперь вы знаете, что это «нервная система» аэропорта, обеспечивающая порядок в небе.

Когда оформляешь РЭ на английском языке, но:

✅в программе остались настройки для русского языка;
✅часть переведенных слов переводить было НЕ НАДО;
✅выясняется, что у каждого человека свой английский, и он единственно правильный...

Первые РЭ на минималках. Нормы русского языка опустим. Разговорный цензурный понятен? Понятен. И так сойдет 😊

PS Хотя бы про обувь не ошиблись

Рабочая рутина накрыла с головой. В последнее время все чаще проскакивает мысль, что да, рутина - это скучно, но с ней обязательно надо подружиться, и тогда, как лучшая подружка, она во-первых, перестанет казаться рутиной, а во-вторых, со временем рано или поздно выдаст свой главный секрет. Заключается он в том, что любая мелочь может иметь весомое, если не решающее значение. Причем это относится не только к техписательской работе, но и практически ко всем сферам нашей жизни.

В той же документации, когда начинаешь проверять буквы, цифры, соответствие ГОСТ, когда находишь новые нюансы, когда в голове новые идеи, пресловутая рутина уже не кажется скучной и неинтересной, а превращается в весьма увлекательное путешествие, в котором время совершенно не замечается.

Существует американский подход к описанию какого-либо процесса. Он заключается в том, чтобы описать все. Нет, не так. ВСЕ! Например:

1.Включите прибор. Щелкните тумблер в положение "вниз". Должна загореться лампочка не позднее, чем через 3 секунды.
2.Лампочка загорелась красным ровным цветом.
3.Прошел процесс.

Для русского инженера это довольно непривычно, так как при создании документации подразумевается, что пользователь многие вещи знает по умолчанию.

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

✈️ 2 февраля прошел день технического писателя, а сегодня, 9-ого - день гражданской авиации. Оба праздника давно считаю своими. От души поздравляю всех причастных к обоим праздникам! Передо мной компьютер, мышь, клавиатура, бумажные документы, в голове роются мысли как сделать лучше/быстрее, а воображение рисует перед глазами небо из иллюминатора самолета!

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

Мне не работается совсем. В прошлом году я очень ждала выхода с удаленки, а сейчас - пришел вызов в больницу на операцию, который, как я думала, будет несколько позже. Потому, не успев войти в рабочий ритм, сбилась с него без шансов на восстановление.

Сейчас хожу на работу, одновременно прохожу бюрократический ад областной поликлиники. Мучаю коллег чёрным юмором, который по жизни мне совершенно не свойственен. Одновременно пытаюсь заставить себя хоть что-то сделать, через силу, через не могу и «совершенно не хочу». Мысленно я уже совершенно не на работе.

Если все бюрократические звёзды сойдутся в правильные созвездия, то жить в режиме 5/2 мне осталось очень недолго, но это не точно.

И настигло меня Его Величество Выгорание. Эмоций уже почти нет. На этот раз никаких удаленок не планирую. Только хардкор, только больничные, которые, правда, обещали не больше чем на две недели.

И на пару - Его Величество Стыд, ибо никак не получается относиться к происходящим событиям буднично, так как реально нет оснований за себя переживать.

Во всей этой истории морально поддерживает мысль, что весной с очень большой вероятностью я смогу сесть за руль 🚲 - это будет лучшая награда за все мои переживания.