Заметки технического писателя pinned «Обращаюсь к вам, подписчики и читатели блога! Каждый может попасть в "Заметки технического писателя". Для этого приглашаю вас на небольшое интервью, в котором вы кратко расскажете о себе, о своей работе, о планах, целях и мечтах. Не важно, являетесь ли вы…»
Так получилось, что я сейчас на удаленке. Причины очень грустные, но не будем об этом. Лучше поговорим о том, what is a удаленка. Во-первых, это когда в дополнение к распитию литров чая добавляется глажка кота . Во-вторых, это когда ночью приходят самые гениальные мысли. Хотя нет, формально не ночью, а как у истинного жаворонка с 4 до 6 утра. Именно в это время в основном и работаю. На дневное время оставляю лишь коммуникацию с коллегами и задачи, не требующие мыслительной деятельности. В-третьих, четкое осознание, что я совершенно не домашний человек, сидение дома - это наказание. Особенно когда прогулка (а для меня это минимум 2-4 часа, меньше не интересно) стала царской роскошью. Я не скучаю по авиационному предприятию, но скучаю по общим нагрузкам. Конечно, 4 часа в день 5/2 в дороге - тоже крайность, но из двух зол мне легче именно в дороге…
Продолжение 11.12.2025
Продолжение 11.12.2025
❤4
Кому ни говорю о том, что устала сидеть дома, меня никто не понимает. А я не понимаю, как можно, наоборот, дома сидеть? Конечно, в жизни всякое бывает, но чтобы добровольно? Наверное, я с другой планеты. Пока официально оформлена на удаленке до нового года, в январе буду вспоминать, что такое рабочая дисциплина. В следующем году есть очень большие шансы повторить маршрут кровать - кот - домашний комп, временно сделавшийся рабочим. Надеюсь, домашний период не придётся на велосезон, иначе мне будет очень-очень грустно.
❤2
Нашла интересный сайт https://prelum.ru/, который позволяет разрабатывать документы по ГОСТ. Лично пока его не пробовала, но если и попробую, то только в качестве развлечения, потому что на авиационном предприятии вряд ли меня поймут. У нас полный консерватизм: никаких интернет-сервисов при разработке и проверке документации, все по старинке. Но, может, кому-то этот сервис подойдет для реальной работы? 🤔
Prelum
Технология разработки документов по государственным стандартам
Начинаем #интервью со смелой девушкой, которая не побоялась быть первопроходцем на Заметках - Еленой Фабрициус @Elena_el3 - технического писателя IT из компании Докзилла (г. Москва).
Елена, расскажите о себе
В прошлом я учитель географии и финансовый менеджер. Техническим писателем стала волей случая: на предпоследнем месте работы была администратором проекта, однако это оказалось не мое, решила уволиться, но руководитель предложил остаться в качестве консультанта по внедрению. В течение 2,5 лет я совмещала обязанности тестировщика, технического писателя и второй линии техподдержки.
Канал читают разные люди, в том числе те, которые никогда не работали в IT. Расскажите пожалуйста, кто такой администратор проекта и консультант по внедрению? Какой именно бэкграунд подошел для новой компании, где вы сейчас работаете техническим писателем?
Администратор - это владелец информации по проекту. Нашим единственным заказчиком была крупная государственная компания. Проект очень сложный, старый, вся документация по ГОСТ. Дополнительно надо было контролировать статус согласований, ездить по организациям, собирать визы. В качестве консультанта по внедрению я тестировала программные модули, обучала пользователей работать с системой, и в разрезе ролей писала руководства.
Почему вы сменили место работы, если вы уже были там фактически как технический писатель?
К сожалению, там были не совсем обязанности технического писателя. В руководствах необходимо было научить пользователя алгоритмам инвестиционных расчетов, при этом меня как техписа подключали лишь на последних стадиях проекта, считая мою роль фактически незначительной. При этом по самим расчетам не было никакой информации, и никто толком не мог помочь. Фактически, меня выкидывали в открытое мое, и плыви, как хочешь. При этом ответственность за правильно выполненную работу никто не отменял. Потому пришлось уйти с должности консультанта по внедрению.
Продолжение 16.12.2025
Елена, расскажите о себе
В прошлом я учитель географии и финансовый менеджер. Техническим писателем стала волей случая: на предпоследнем месте работы была администратором проекта, однако это оказалось не мое, решила уволиться, но руководитель предложил остаться в качестве консультанта по внедрению. В течение 2,5 лет я совмещала обязанности тестировщика, технического писателя и второй линии техподдержки.
Канал читают разные люди, в том числе те, которые никогда не работали в IT. Расскажите пожалуйста, кто такой администратор проекта и консультант по внедрению? Какой именно бэкграунд подошел для новой компании, где вы сейчас работаете техническим писателем?
Администратор - это владелец информации по проекту. Нашим единственным заказчиком была крупная государственная компания. Проект очень сложный, старый, вся документация по ГОСТ. Дополнительно надо было контролировать статус согласований, ездить по организациям, собирать визы. В качестве консультанта по внедрению я тестировала программные модули, обучала пользователей работать с системой, и в разрезе ролей писала руководства.
Почему вы сменили место работы, если вы уже были там фактически как технический писатель?
К сожалению, там были не совсем обязанности технического писателя. В руководствах необходимо было научить пользователя алгоритмам инвестиционных расчетов, при этом меня как техписа подключали лишь на последних стадиях проекта, считая мою роль фактически незначительной. При этом по самим расчетам не было никакой информации, и никто толком не мог помочь. Фактически, меня выкидывали в открытое мое, и плыви, как хочешь. При этом ответственность за правильно выполненную работу никто не отменял. Потому пришлось уйти с должности консультанта по внедрению.
Продолжение 16.12.2025
👍2❤1
Продолжаем #интервью с техническим писателем в IT Еленой Фабрициус @Elena_el3 (г. Москва)
Но вы ушли не сразу.
Да, сначала я ушла на три года в декрет, мне тогда было 40, и оттуда уже не вернулась в старую компанию.
Несмотря на сложности предыдущей работы, вы смогли уйти в компанию, где работаете непосредственно техническим писателем
Да, сейчас я работаю в компании Докзилла техписателем - аналитиком, где мне пригодилось многое: я работаю с документами по ГОСТ, участвую в развитии и внедении базы знаний, разрабатываю решения для автоматизации, направленные для сокращения рутинных задач.
При этом вы работаете удаленно
Да, это плюс, так как не нужно тратить время на дорогу, и минус, так как несколько отвыкаешь от коллектива.
В предварительной беседе вы сказали, что у вас есть три ментора. Расскажите, кто это такие как они с вами взаимодействуют?
По сути, менторы - это наставники. Первого ментора мне нанял мой нынешний работодатель. Второго я выиграла в "Бесплатной ежегодной программе наставничества для женщин в IT", с третьим я работаю сама в рамках процессов в Битрикс.
Спасибо вам за интервью. Было очень интересно взглянуть на ваш опыт. Желаю вам дальнейшей эффективной работы!
Напоминаю, что любой подписчик и читатель канала вне зависимости от сферы деятельности может попросить об интервью, поставив в комменатрии к этой заметке "+интервью". Подробности - в закреплённом сообщении канала.
Но вы ушли не сразу.
Да, сначала я ушла на три года в декрет, мне тогда было 40, и оттуда уже не вернулась в старую компанию.
Несмотря на сложности предыдущей работы, вы смогли уйти в компанию, где работаете непосредственно техническим писателем
Да, сейчас я работаю в компании Докзилла техписателем - аналитиком, где мне пригодилось многое: я работаю с документами по ГОСТ, участвую в развитии и внедении базы знаний, разрабатываю решения для автоматизации, направленные для сокращения рутинных задач.
При этом вы работаете удаленно
Да, это плюс, так как не нужно тратить время на дорогу, и минус, так как несколько отвыкаешь от коллектива.
В предварительной беседе вы сказали, что у вас есть три ментора. Расскажите, кто это такие как они с вами взаимодействуют?
По сути, менторы - это наставники. Первого ментора мне нанял мой нынешний работодатель. Второго я выиграла в "Бесплатной ежегодной программе наставничества для женщин в IT", с третьим я работаю сама в рамках процессов в Битрикс.
Спасибо вам за интервью. Было очень интересно взглянуть на ваш опыт. Желаю вам дальнейшей эффективной работы!
Напоминаю, что любой подписчик и читатель канала вне зависимости от сферы деятельности может попросить об интервью, поставив в комменатрии к этой заметке "+интервью". Подробности - в закреплённом сообщении канала.
👍2
В прошлую пятницу была на мастер-классе по каллиграфии, уже второй раз. В первый так понравилось, что купила для занятий дома собственную перьевую ручку, прописи и чернила вместо туши. Во второе посещение разобрала ошибки, на которых застряла, когда занималась дома. Поняла, что чернила для каллиграфии категорически не подходят. Пословица написана моей рукой. Очень символичная фраза, которая очень откликается и по работе (не получалось о ней не думать!) и по жизни.
Удивительно, но даже час занятий очень хорошо разгружает мозг от повседневных проблем, помогает сконцентрироваться и мысленно отсечь все лишнее и не важное для жизни. Как будто и сеанс отдыха и внутренней перенастройки одновременно. Потому очень рекомендую мастер-классы подобной направленности!
Удивительно, но даже час занятий очень хорошо разгружает мозг от повседневных проблем, помогает сконцентрироваться и мысленно отсечь все лишнее и не важное для жизни. Как будто и сеанс отдыха и внутренней перенастройки одновременно. Потому очень рекомендую мастер-классы подобной направленности!
❤4🔥2
Сейчас ночи длиннее, чем дни, но и они могут быть завораживающе красивыми, если смотреть на них через иллюминатор самолета ✈️
Forwarded from Пилот Компот
Северное ✨✨✨
Телефон надо горизонтально повернуть
Тогда вообще красиво 😍
Телефон надо горизонтально повернуть
Тогда вообще красиво 😍
🔥3❤1
Нужно ли писать документацию быстро (или быстрее, чем привычно?), а, главное, зачем? На одном из профильных каналов увидела список лайфхаков, как это можно сделать. Актуально для айтишников. Но если переложить их советы для тех кто пишет по ГОСТ... Итак, поехали!
1️⃣ Пишите для себя в будущем
Если в IT актуальны автоматизация процессов и работа с целевой аудиторией, то у "гостовиков" техписатель обычно не влияет на автоматизацию, а целевая аудитория - это заказчик, который прописывает конкретные цели в техническом задании. Конечно, в рамках жизненного цикла и последующей эксплуатации изделия некоторые параметры могут быть откорректированы, но на конечные характеристики они никак не должны повлиять - иначе вводится новое исполнение.
Итак, что же тогда подразумевается под "писать для себя в будущем", будь то ПС, РЭ, ТУ, ФО и т. д.? Раскроем это в последующих советах.
2️⃣ Используйте шаблоны
Как правило, если процесс работы над документацией отлажен, то шаблоны в виде рамок, таблиц определенной формы и размеров уже существуют, а также последовательностью изложения информации. Дополнительно можно взять готовый редактируемый документ, принятый всеми инстанциями, пересохранить и откорректировать под себя. Использование ИИ не допускается. Готовые шаблоны значительно ускоряют создание документации.
А в ситуации, когда документ на предприятии выпускается впервые, либо техническая документация изначально выпускается с нуля, некоторое время придется потратить на то, чтобы довести документ до ума, или, точнее, до полного соответствия текущей версии ГОСТ.
Продолжение 23.12.2025
1️⃣ Пишите для себя в будущем
Если в IT актуальны автоматизация процессов и работа с целевой аудиторией, то у "гостовиков" техписатель обычно не влияет на автоматизацию, а целевая аудитория - это заказчик, который прописывает конкретные цели в техническом задании. Конечно, в рамках жизненного цикла и последующей эксплуатации изделия некоторые параметры могут быть откорректированы, но на конечные характеристики они никак не должны повлиять - иначе вводится новое исполнение.
Итак, что же тогда подразумевается под "писать для себя в будущем", будь то ПС, РЭ, ТУ, ФО и т. д.? Раскроем это в последующих советах.
2️⃣ Используйте шаблоны
Как правило, если процесс работы над документацией отлажен, то шаблоны в виде рамок, таблиц определенной формы и размеров уже существуют, а также последовательностью изложения информации. Дополнительно можно взять готовый редактируемый документ, принятый всеми инстанциями, пересохранить и откорректировать под себя. Использование ИИ не допускается. Готовые шаблоны значительно ускоряют создание документации.
А в ситуации, когда документ на предприятии выпускается впервые, либо техническая документация изначально выпускается с нуля, некоторое время придется потратить на то, чтобы довести документ до ума, или, точнее, до полного соответствия текущей версии ГОСТ.
Продолжение 23.12.2025
3️⃣ Ускорьте создание текста
В профильном канале совет звучит так:
Не знаю, используется ли Docs as Code для оформления документации по ГОСТ (у нас точно нет). Поделюсь личным опытом: обычно иду либо от понятного к непонятному, то есть, работаю с даными, которые мне передали разработчики и оформляю разделы, которым они соответствуют. Либо сначала иду на испытательный стенд, подключаю к нему изделие и проверяю, насколько верно мне дали информацию, при необходимости уточняю и корректирую и лишь затем сажусь за написание документа.
4️⃣ Автоматизируйте всё, что можно автоматизировать
Как я и говорила чуть выше, нейрогенерация у нас категорически не допускается. Но у нас допускается небольшая автоматизация в виде макросов, которые настраивают название раздела, дату, номер страницы и т. д. При работе с РЭ по ГОСТ 18675-12 автоматизация внешнего вида документа происходит за счет специальной программы.
5️⃣ Настройте проверки
В IT сфере допустимо использовать разные спеллчекеры - компьютерные программы, проверяющие текст на орфорграфические и пунктуационные ошибки. А я даже не могу сделать через сервисы, которые применяю в копирайтинге.Только ручками и глазками. Но у меня есть свой собственный чек-лист, который включает себя проверку документа по определенным словам и критериям. Поделиться пока не могу, потому что для каждого документа свой индивидульный подход, в связи с которым чек-лист рождается прямо на ходу
Продолжение 24.12.2025
В профильном канале совет звучит так:
В инструкциях используйте пирамиду Минто: изложите сначала главную мысль или цель, для чего нужны последующие действия, а затем излагайте их. Такой метод подходит для большинства типов документации. Придерживайтесь его, и вы потратите гораздо меньше времени на раздумья. А для написания текста настройте инструменты ускоренного ввода, например сниппеты для VS Code, и используйте горячие клавиши.Не знаю, используется ли Docs as Code для оформления документации по ГОСТ (у нас точно нет). Поделюсь личным опытом: обычно иду либо от понятного к непонятному, то есть, работаю с даными, которые мне передали разработчики и оформляю разделы, которым они соответствуют. Либо сначала иду на испытательный стенд, подключаю к нему изделие и проверяю, насколько верно мне дали информацию, при необходимости уточняю и корректирую и лишь затем сажусь за написание документа.
4️⃣ Автоматизируйте всё, что можно автоматизировать
Как я и говорила чуть выше, нейрогенерация у нас категорически не допускается. Но у нас допускается небольшая автоматизация в виде макросов, которые настраивают название раздела, дату, номер страницы и т. д. При работе с РЭ по ГОСТ 18675-12 автоматизация внешнего вида документа происходит за счет специальной программы.
5️⃣ Настройте проверки
В IT сфере допустимо использовать разные спеллчекеры - компьютерные программы, проверяющие текст на орфорграфические и пунктуационные ошибки. А я даже не могу сделать через сервисы, которые применяю в копирайтинге.Только ручками и глазками. Но у меня есть свой собственный чек-лист, который включает себя проверку документа по определенным словам и критериям. Поделиться пока не могу, потому что для каждого документа свой индивидульный подход, в связи с которым чек-лист рождается прямо на ходу
Продолжение 24.12.2025
❤1
А теперь пытаюсь ответить на второй вопрос: зачем писать документацию быстрее? С одной стороны, причины очевидны: сроки, определяемые заказчиком и юридически значимой сопутствующей документацией, KPI. Надо учесть, что техпис никогда не работает один: его "писанину" должны посмотреть метролог, нормоконтролер и так далее. Если же нет "давящих сроков", то, честно говоря, не вижу ни одной причины писать быстрее. Техпис (на мой взгляд) - это в первую очередь мыслитель (нужно сначала переварить информацию, переданную разработчиками) и лишь затем писака. И если на мыслительный процесс излишне давить, то на выходе документ получится "не очень". Возможно, у вас другое мнение - напишите в комментариях.
Как вам такое совмещение авиации✈️ и католического Рождества🎄?
❤3
Два пилота из США и Канады нарисовали Гринча в небе своими самолётами. Первый за 2,5 часа изобразил похитителя Рождества рядом с канадским Гоффсом на Cirrus SR22. Второй за три часа воссоздал крадущуюся фигуру над Огайо на винтажном Piper PA-28 1965 года.
У всех сейчас настроение "давайте перенесем это на следующий год"? У кого мечты совпали с реальностью? У меня нет, буду работать до конца, но отношусь к этому совершенно спокойно. Все же, чем больше сделаю в этом году, тем меньше буду делать в следующем. ☝️
Пролетел 2025 год, наполненный весьма неожиданными для меня событиями. Остались последние рабочие деньки - 29 и 30 декабря. Я не подвожу итоги специально к 1 января, не строю никаких грандиозных планов. С 12 января выхожу 5/2. На днях подсчитала и ужаснулась: в течение 2025 года я на удаленках совокупно провела 3,5 месяца, на официальном больничном 2 недели, в отпусках - 22 дня (остальные дни перенесла на будущее) + дни, когда отпрашивалась - по разным причинам. Итого меня физически не было на работе примерно 5 😱😱😱месяцев. Спасибо руководителям за то, во многом пошли мне навстречу и коллегам за частичную помощь в моих трудовых обязанностях, которые не могла выполнять из-за невозможности физически присутствовать на работе.
Я встала на очередь на операцию в одно солидное лечебное учреждение, жду вызов в следующем году (в каком месяце - не знаю). Вроде и диагноз не страшный, и операция прогрессивная (я про нее прочитала, наверное, на 20 разных сайтах, если не больше), и перспективы на будущее хорошие, а все равно несколько волнительно. Однако диагноз не помешает кататься на работу и обратно на велосипеде до начала операции, а после велосезон на 2026 год для меня закончится. Так что в следующем году ожидаю, что уйду на больничный, а с него - на удаленку (вот такой я работоголик!) на некоторый период.
Самое интересное, что за период вынужденной удаленки были не только эмоции (а их было ой как много, это сейчас я уже в последней стадии принятия новой реальности), но и чудеса там, где их не ждала. Они выражались в том, что со мной случались абсолютно нетипичные события, в результате которых я получала мощную поддержку от людей, которых видела в первый и последний раз в жизни.
Несколько раз порывалась написать пост в стиле "пожалейте меня" и тут же стирала его, так как категорически не хотела (и сейчас не хочу), чтобы меня жалели. Я долго раздумывала, писать об операции сейчас или сделать это по факту нахождения в стационаре, но интуиция подсказывает, что лучше сейчас.
Я встала на очередь на операцию в одно солидное лечебное учреждение, жду вызов в следующем году (в каком месяце - не знаю). Вроде и диагноз не страшный, и операция прогрессивная (я про нее прочитала, наверное, на 20 разных сайтах, если не больше), и перспективы на будущее хорошие, а все равно несколько волнительно. Однако диагноз не помешает кататься на работу и обратно на велосипеде до начала операции, а после велосезон на 2026 год для меня закончится. Так что в следующем году ожидаю, что уйду на больничный, а с него - на удаленку (вот такой я работоголик!) на некоторый период.
Самое интересное, что за период вынужденной удаленки были не только эмоции (а их было ой как много, это сейчас я уже в последней стадии принятия новой реальности), но и чудеса там, где их не ждала. Они выражались в том, что со мной случались абсолютно нетипичные события, в результате которых я получала мощную поддержку от людей, которых видела в первый и последний раз в жизни.
Несколько раз порывалась написать пост в стиле "пожалейте меня" и тут же стирала его, так как категорически не хотела (и сейчас не хочу), чтобы меня жалели. Я долго раздумывала, писать об операции сейчас или сделать это по факту нахождения в стационаре, но интуиция подсказывает, что лучше сейчас.
❤7🙏3🔥1
Я прощаюсь с 2025 годом со смешанными чувствами. С одной стороны, дикая усталость и вселенская грусть, с другой - тихая радость, для которой, к счастью, есть основания. У меня нет того новогоднего настроения, которое нам усиленно пропагандируют из всех утюгов. Но есть свое собственное, с которым хочу провести этот Новый Год и последующие праздничные дни.
Для меня это время, когда я сознательно буду не гоняться за новогодним настроением или развлечениями, а... просто не спешить. Никуда не бежать. Не пытаться что-то непременно успеть. Отпустить многое, возможно, простить многих. Перестать обо многом (если не обо всем) жалеть. Не искать якобы упущенное или выгодное.
Но! Слушать тишину и крики чаек среди нее. Настроиться на один ритм с Финским заливом. Говорить на одном языке с шелестом ветра и шорохами природы. Список "не" и "но" можно продолжать бесконечно.
Я по жизни никогда не жду чудес, не прошу и их ни от Бога, ни от судьбы, но что-то подсказывает, что самое интересное еще впереди.
PS Сегодня последний день моей внутренней мобилизованности, то есть, готовности принять звонок или сообщение по работе. 29 и 30 декабря я должна была по графику идти в отпуск, от которого в итоге отказалась, но нисколько не жалею об этом. А с завтрашнего дня я буду полностью отключаться от своих экстремально насыщенных ранее будней, в том числе, на некоторое время полностью сменю обстановку (но буду в пределах Санкт-Петербурга и области).
Для меня это время, когда я сознательно буду не гоняться за новогодним настроением или развлечениями, а... просто не спешить. Никуда не бежать. Не пытаться что-то непременно успеть. Отпустить многое, возможно, простить многих. Перестать обо многом (если не обо всем) жалеть. Не искать якобы упущенное или выгодное.
Но! Слушать тишину и крики чаек среди нее. Настроиться на один ритм с Финским заливом. Говорить на одном языке с шелестом ветра и шорохами природы. Список "не" и "но" можно продолжать бесконечно.
Я по жизни никогда не жду чудес, не прошу и их ни от Бога, ни от судьбы, но что-то подсказывает, что самое интересное еще впереди.
PS Сегодня последний день моей внутренней мобилизованности, то есть, готовности принять звонок или сообщение по работе. 29 и 30 декабря я должна была по графику идти в отпуск, от которого в итоге отказалась, но нисколько не жалею об этом. А с завтрашнего дня я буду полностью отключаться от своих экстремально насыщенных ранее будней, в том числе, на некоторое время полностью сменю обстановку (но буду в пределах Санкт-Петербурга и области).
❤4