Недавно на одном специлизированном телеграм-канале технических писателей нашла обсуждение на тему: диалекты Markdown - это добро или зло. Markdown - это язык разметки для текстовых документов. Он помогает форматировать текст, делая его читабельным как в исходном виде, так и в преобразованном формате, например в HTML. В ходе обсуждения многие склонились к тому, что это зло, так как: 1) их расплодилось слишком много, аж 30+; 2)каждый диалект направлен исключительно на свой пласт задач, из-за чего язык разметки перестал быть универсальным.

На авиационном предприятии я не работаю с разметкой, но тоже самое могу сказать об обновлениях ГОСТ - это однозначное зло.
На изделия, выпущенные до такого-то года, выпускаются документы по такому-то ГОСТ в редакции такой-то, и графы таблиц отделяются от основной части одинарной линией. А после выпускается новая редакция, либо новый ГОСТ взамен предыдущего, и по нему графы таблиц отделяются от основной части двойной линией.🤦‍♀️🤦‍♀️🤦‍♀️ Ухитрилась застать и смену стандарта записи единиц измерения. То от +5 до -5, от плюс 5 до минус 5.

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

Потому я - за единство и неизменяемость стандартов.

#рабочее

Приключения документации на предприятии, если это был бы литературный роман 📝➕✈️🟰❓❓❓Часть 4

Роман-утопия:
✅Документация рождается в своем темпе.
✅Документация проходит все проверки без единого замечания.
✅Документацию по случайности первой среди большой стопки документов из других отделов оформили в архиве.

Роман-антиутопия:
✅Документация рождается среди хаоса требований, которые противоречат друг другу
✅Техпис и разработчик думали: "И так сойдет!"
✅И так не сошло. R.I.P.

Роман-притча:
✅Жили-были техпис с разработчиком
✅И разрабатывали они документацию долго и (не)счастливо, нужное подчеркнуть
✅Мораль - придумайте сами

Роман-постмодерн:
✅Жили-были техпис с разработчиком
✅И разрабатывали они документацию долго и (не)счастливо, нужное подчеркнуть
✅Техпис возомнил себя королем документации, а разработчику милостиво уделил роль первого слуги

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

#юмор #приключения_документации_роман

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

✅ Для какого конкретного документа нужен этот ГОСТ?
✅ Какие разделы документа нужно оформить?
✅Как оформляются абзацы, таблицы, рисунки?
✅Нужны ли рамки и если да, то как оформляются?
✅Как оформляется титульный лист?
✅Какие технические сведения должны быть в документе?

А теперь вишенка на торте: для полного понимания, как устроена документация, одного знания ГОСТ недостаточно. Все сведения, вносимые в конкретный документ должны быть подтверждены теми же сведениями, но из других документов. Ни одна цифра не должна быть «одиночной». Чтобы понимать эту взаимосвязанность, необходимо изучить все КД и ЭД, выпускаемое на изделие, открывать каждый документ и сравнивать цифры. И здесь, скорее всего, нужен не чек-лист, а больше таблица или инфографика: пока ещё не решила.

Коллеги, а есть ли у вас подобный чек-лист, либо отдельные вопросы, которые задаете себе, когда изучаете новый ГОСТ (или стайлгайд)?

#рабочее

Это канал про техническое писательство с уклоном в авиационную тематику. Пишу очередную заметку, а в голове: "Хорошо живет на свете Винни Пух, от того поет он эти песни вслух!" Решила не противиться внутреннему голосу и потому мысленно пропела дальше: "В голове моей опилки! Да! Да! Да!" И уже от себя: "Разберемся с ними быстро! Е-рун-да!" Я с рождения слушаю разную музыку, потому многие мелодии, в зависимости от настроения, воспроизводятся по памяти.

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

#юмор

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

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

#рабочее

О чем мечтаю в профессиональной жизни?✈️

Ещё в 2015 году, когда о профессии «технический писатель» была ни сном, ни духом, мечтала попасть на какой-нибудь завод и писать про механизмы и агрегаты. Через 7 лет я ее воплотила в реальность, устроившись на авиационное предприятие. А дальше что? Развитие, карьера, деньги - стандартные и в целом понятные желания, но моя женская интуиция говорила, что это не то.

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

#рабочее

Приключения документации на предприятии, если это был бы литературный роман 📝➕✈️🟰❓❓❓Часть 5

Детективный роман:
✅Техпис спокойно писал документацию
✅Техпис попивал чай, в полудреме глядя на монитор
✅Мысль пронзила как молния: вот этот и этот параметр взялись из ниоткуда. Как это произошло?

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

Исторический роман:
✅Техпис пришел на новую работу
✅Техпис увидел полный бардак в документации, доставшейся от предыдущего техписа
✅Техпис разгреб авгиевы конюшни правок и замечаний, накопившихся от разработчиков

Эпический роман:
✅Техпис усердно работал над документацией
✅Техпис разрабатывал принципы и оттачивал стилистику написания документации
✅Техпис добился расширения штата и взял несколько техписов-помощников

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

#юмор #приключения_документации_роман

Как я веду канал «Заметки технического писателя» ✈️➕📝🟰❤️ Часть 1. Начало

Меня периодически спрашивают, как я веду свой канал. Решила приоткрыть завесу тайны.

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

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

С трудом преодолевая своё стеснение, я начала рекламировать свой канал, и теперь нас почти 200.

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

Как я веду канал «Заметки технического писателя» ✈️➕📝🟰❤️ Часть 2. Моя политика

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

Главным «оружием» канала считаю искренность и открытость, которые стараюсь выразить в каждом личном посте.

И, конечно, очень придирчиво проверяю грамматику, пунктуацию, стилистику: часто, написав заметку и отправив публикацию в отложенное, возвращаюсь и что-то корректирую.

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

Как я веду канал «Заметки технического писателя» ✈️➕📝🟰❤️ Часть 3. Где беру вдохновение

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

Если раньше я хотела писать исключительно про ГОСТ, то теперь хочется подсвечивать профессию технического писателя с самых разных сторон, насколько фантазии хватит.

Приключения документации на предприятии, если это был бы литературный роман 📝➕✈️🟰❓❓❓Часть 6

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

Роман по DnD:
✅Техпис начал работать над документацией
✅Техпис прокачал свой уровень до "много-много умею"
✅Техпис убил внутренних драконов и словил дзен

Научно-фантастический роман:
✅Техпис работает над супер-пупер инновационным продуктом или изделием
✅Техпис встретил для себя что-то новое
✅Техпис больше не техпис. У него другая должность и в целом другая рабочая жизнь

Роман по WH 40.000:
✅Техпис вышел на новую работу и начал работать над документацией после предыдущего техписа
✅Техпис пытался доказать, что он не виноват в ошибках, сделанных предшественником
✅Техпис был рад уволиться по окончанию испытательного срока - легко отделался

#юмор #приключения_документации_роман

📌 Что такое ГОСТ? Часть 1

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

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

Первый стандарт утвердили 7 мая 1926 года. Это был ОСТ-1 «Пшеница. Селективные сорта зерна. Номенклатура» - Общесоюзный государственный стандарт. Буква «Г» в стандартах возникла позже. Аббревиатура ГОСТ утвердилась с июля 1940 года, когда был учрежден Всесоюзный комитет по стандартизации.

Первый ГОСТ регламентировал, угадайте? Правильно! оформление ГОСТов! Это был ГОСТ 1-40 «Размеры и оформление стандартов». С 3 октября 1940 года ГОСТЫ стали нумеровать. Первая цифра означала порядковый номер стандарта, а цифры, идущие через дефис – год его утверждения или пересмотра.

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

📌 Что такое ГОСТ? Часть 2

Например, ГОСТ 28253-89 был утвержден еще во времена СССР для производства шелковых и полушелковых тканей. К слову, этот стандарт действует и сегодня. Итак, расшифровываем: Государственный Общесоюзный стандарт, зарегистрированный под номером 28253 в 1989 году.

А вот стандарт посовременнее – ГОСТ Р 53118-2008. В нем указаны технические требования к изготовлению, анализу, правилам приемки, транспортировки и хранения варенья. Что мы тут имеем: Государственный стандарт Российской Федерации (если обратили внимание, то добавилась буква «Р»), зарегистрированный под номером 53118 в 2008 году.

С 1992 года ГОСТ означает «межгосударственный стандарт» стран Содружества Независимых Государств (СНГ). Его принимает Межгосударственный совет по стандартизации, метрологии и сертификации.

27 декабря 2002 года в России был принят Федеральный закон No184, вводящий понятия «стандарт» и «технический регламент». А это значит, что теперь необязательно производить продукцию в соответствии с ГОСТ. Государственные стандарты применяются на добровольной основе. А зря, наверное!

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

#околорабочее