Мечтать начать собираться послать купить выпить писать документацию

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

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

https://yandex.cloud/ru/content-program

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

PS Грант - это скидка на оплату сервисов Yandex Cloud, а не начисления на карту...

В продуктовой сети "Лента" уже во всю продают новогоднюю атрибутику. Я уже думаю, что бы купить ПОСЛЕ новогодних праздников, когда это все подешевеет до неприличия. И рефреном крутится песня: "А я счастлива в моменте, новый год будет лучше, чем прежде!" Так и хотелось отрифмовать: "А я покупаю в "Ленте", и я счастлива в моменте!" Обычно я не придирчива даже к самым графоманским моментам, но здесь... "Счастлива в моменте" - это не разговорный язык, и даже не письменный литературный, не говорят так между собой, не пишут так в письмах!!! Это совершенно искусственная словесная конструкция, которая пытается убедить нас, что все будет "еще лучше, чем прежде". К счастью, на меня такие вещи в эмоциональном плане не действуют, потому и включила режим "граммар-наци".

А вы счастливы в моменте? К сожалению, я не нашла в интернете полный текст этой песни, чтобы устроить ей показательный разнос. Буду рада, если кто-нибудь в комментариях под заметкой даст на нее ссылку. Вот тогда я точно буду "счастлива в моменте" 😅

🚀 ГИРД-Х - первый ракетный проект Сергея Павловича Королёва

В холодный ноябрьский день, в 1933 году, в подмосковном Нахабино была запущена первая советская ракета с жидкостным двигателем ГИРД-Х конструкции Ф. А. Цандера.

Всё началось с создания Фридрихом Цандером и его первой бригадой ГИРД жидкостного двигателя ОР-10. Он работал на жидком кислороде и этиловом спирте, развивал тягу 70 килограммов. Ракета на базе ОР-10 по современным меркам получилась небольшой 2,2 метра и весом около 30 кг. При пуске ракета взлетела вертикально на высоту 80 м.

Конструкция ГИРД-Х получила развитие в более совершенных советских ракетах, созданных в 1935—1937 гг.

Цандер до старта своей ракеты не дожил и проект реализовал его соратник по ГИРД Сергей Королёв.

Обращаюсь к вам, подписчики и читатели блога! Каждый может попасть в "Заметки технического писателя". Для этого приглашаю вас на небольшое интервью, в котором вы кратко расскажете о себе, о своей работе, о планах, целях и мечтах. Не важно, являетесь ли вы техническим писателем или работаете в другой области - любая профессия важна.

☝️Как это будет происходить❓

1️⃣Вы ставите "+ интервью" в комментарии под этим постом
2️⃣Я с вами связываюсь в личных сообщениях, где мы знакомимся, и затем задаю вопросы
3️⃣Готовлю 1-2 отложенные публикации, согласовываю их с вами, сообщаю даты. При желании вставлю ссылку на ваш аккаунт в Телеграм

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

Прошедшие #интервью ищите по тегу

Я стараюсь также выискивать недочеты в документации, как эта девушка из города Глазго (Шотландия)

😎 7 декабря отмечают Международный день гражданской авиации. ✈️

Так получилось, что я сейчас на удаленке. Причины очень грустные, но не будем об этом. Лучше поговорим о том, what is a удаленка. Во-первых, это когда в дополнение к распитию литров чая добавляется глажка кота . Во-вторых, это когда ночью приходят самые гениальные мысли. Хотя нет, формально не ночью, а как у истинного жаворонка с 4 до 6 утра. Именно в это время в основном и работаю. На дневное время оставляю лишь коммуникацию с коллегами и задачи, не требующие мыслительной деятельности. В-третьих, четкое осознание, что я совершенно не домашний человек, сидение дома - это наказание. Особенно когда прогулка (а для меня это минимум 2-4 часа, меньше не интересно) стала царской роскошью. Я не скучаю по авиационному предприятию, но скучаю по общим нагрузкам. Конечно, 4 часа в день 5/2 в дороге - тоже крайность, но из двух зол мне легче именно в дороге…

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

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

Нашла интересный сайт https://prelum.ru/, который позволяет разрабатывать документы по ГОСТ. Лично пока его не пробовала, но если и попробую, то только в качестве развлечения, потому что на авиационном предприятии вряд ли меня поймут. У нас полный консерватизм: никаких интернет-сервисов при разработке и проверке документации, все по старинке. Но, может, кому-то этот сервис подойдет для реальной работы? 🤔

Начинаем #интервью со смелой девушкой, которая не побоялась быть первопроходцем на Заметках - Еленой Фабрициус @Elena_el3 - технического писателя IT из компании Докзилла (г. Москва).

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

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

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

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

Продолжаем #интервью с техническим писателем в IT Еленой Фабрициус @Elena_el3 (г. Москва)

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

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

При этом вы работаете удаленно
Да, это плюс, так как не нужно тратить время на дорогу, и минус, так как несколько отвыкаешь от коллектива.

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

Спасибо вам за интервью. Было очень интересно взглянуть на ваш опыт. Желаю вам дальнейшей эффективной работы!

Напоминаю, что любой подписчик и читатель канала вне зависимости от сферы деятельности может попросить об интервью, поставив в комменатрии к этой заметке "+интервью". Подробности - в закреплённом сообщении канала.

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

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

Сейчас ночи длиннее, чем дни, но и они могут быть завораживающе красивыми, если смотреть на них через иллюминатор самолета ✈️

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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