Заметки технического писателя
190 subscribers
234 photos
16 videos
54 links
Технический писатель. В настоящий момент работаю в авиационной отрасли.
Download Telegram
✈️Наступил ноябрь. В Санкт-Петербурге он раскрашен 50 и более оттенками серого. Солнце решило впасть в спячку вместе с остальной природой, зато работа вовсю кипит. Техническая документация находится на самом финише выпуска продукции, казалось бы, все 100500 раз перепроверено, но:

🛬🛫
Ой, тут надо белый цвет!
Мы же ранее исправляли на голубой.
Надо белый, так удобно летчикам.
Окей.

🛬🛫
Меняем в документе цифру 50 на цифру 60.
Почему?
Изменились параметры.
Хорошо.

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

✈️Нормально ли постоянно что-то находить и исправлять? Отвечаю – да! Все исправления нововводимой или ранее выпущенной продукции происходят в рамках жизненного цикла (ГОСТ Р 56136-2014). И пока авиаизделие не будет снято с производства, такие диалоги будут происходить регулярно.

#жизненный_цикл #ГОСТ_Р_56136_2014 #околорабочее
✈️На неделе в одном из авиационных телеграмм-каналов узнала про ИИ Air Guardian, который готов взять на себя работу второго пилота, чтобы активно помогать первому. ИИ, в принципе, полезная вещь, но...

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

Пока ИИ - это только костыли для работы с текстами. Не могут они создавать полноценный материал. А до текстов по ГОСТ им тем более как до Луны пешком.

Перед тем, как устроиться на работу или взяться за проект, мы подписываем бумагу о неразглашении информации. Загружая объекты авторского права в AI (код, изображение, созданный текст), нужно помнить, что права на них могут появиться у разработчика или другого пользователя AI. Сгенерированный ИИ контент также может быть использован разработчиком (правообладателем) ИИ, в том числе в маркетинговых целях.

Вся документация разрабатывается строго по ГОСТ. Насколько мне известно, ИИ пока этому не обучена.

✈️Сейчас права, обязанности и нарушения в сфере разработанного AI контента пока не регулируется. Однако в будущем это может привести либо к конкурентным, либо репутационным, либо судебным издержкам. Будут ли разработаны соответствующие меры защиты информации - покажет время. Потому однозначного ответа за заданный вопрос у меня нет.

#околорабочее
✈️Век живи, век учись. Избитая аксиома засияла новыми красками, когда неожиданно узнала, что букву "з" в перечислении использовать никак нельзя. Как я намучилась в ворде сначала со списком, а затем с его форматированием, ни в сказке сказать, ни пером описать. А во всем "виноват" пункт 6.7.2 ГОСТ Р 2.105-2019, в котором понятно только то, что требования к буквам аналогичны к требованиям к пункту 6.3.5, в котором указано, какие буквы русского алфавита нельзя использовать в приложениях, оформляемых в документации по ЕСКД.

Итак, "расстрельный" список русского алфавита: Ё, З, Й, О, Ч, Ь, Ы, Ъ.
"Расстрельный" список латинского алфавита: I и О.

В чертежах список запретных букв указан в пункте 18 ГОСТ 2.316-68: Й, О, X, Ъ, Ы, Ь.

#списки #приложения #ГОСТ_Р_2_105_2019 #ГОСТ_2_316_68
✈️По работе часто приходится иметь дело с габаритным чертежом. Самостоятельно его не составляю, но для оформления своей документации, либо для выполнения поручений руководителя использую регулярно. А потому решила в рамках самообразования изучить его детально. И началось.

Термин "габаритный чертеж" указан в пункте 1.2 ГОСТ 2.102-68 - это документ, содержащий контурное (упрощенное) изображение изделия с габаритными, установочными и присоединительными размерами.

При этом термин "чертеж" описан в пункте 3.1.3.29 ГОСТ Р 7.0.3-2006 - условное графическое изображение предмета с точным соотношением его размеров, полученное методом проецирования.

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

#ГОСТ_2_102_68 #ГОСТ_Р_7_0_3_2006 #околорабочее
Latécoère Late 631 — французский гражданский гидросамолёт, разработанный компанией Latécoère в конце 1930-х и совершивший первый полёт 4 ноября 1942 года. Иллюстрация датирована примерно 1949 годом.

#околорабочее #авиация
👍1
✈️В профессии "технический писатель" очень много направлений. Это как врач-стоматолог и врач-ортопед. Оба врачи, однако такие разные. Как и технические писатели. Одни работают по ГОСТ 2 (как я), другие по ГОСТ 19, третьи - по ГОСТ 34, четвертые в глаза его не видели. Есть писатели с базовыми навыками в IT. А есть те, для которых слова "код", "API", "маркдаун", "жира" и прочее все равно что китайская грамота. Мне всегда было интересно, как работают мои коллеги по цеху, о чем думают, какие у них вопросы, и мысленно говорю им спасибо за то, что могу немного с другого ракурса посмотреть на техническое писательство в целом.

#околорабочее
🔥1
👆С чего начинается родина? С чего начинается профессия технического писателя? Для меня она началась с вакансий на хедхантере, которые увидела еще в 2020 году. На тот момент кроме слова "писатель" для меня ничего не понятно. Чтобы это "ничего" превратилось" в "хоть что-то" пошла на курсы, которые дали только корочку. А реальные знания пришли в рамках самообразования. И одним из якорей стал Профессиональный стандарт технического писателя. Номер действующего на тот момент документа, увы, не вспомню. Нынешний документ №609н от 03.10.22 г. действует с 01.03.2023 по 01.03.2029 г.

В профстандарте четко указано, что должен уметь технический писатель в рамках своих должностных обязанностей. Так, первый же код

А - Оформление и компоновка технической документации... делится на 4 уровня квалификации, обозначенными кодами А/01.4-А/07.4:

1️⃣Компоновка документа.
2️⃣Оформление в текстовом редакторе по шаблону.
3️⃣Перенос контента в базу знаний.
4️⃣Разметка с помощью заданного языка разметки для публикации.
5️⃣Разметка с помощью заданного языка разметки для локализации.
6️⃣Подготовка списка изменений.
7️⃣Публикация.

Все операции кода А соответствуют уровню квалификации 4. К сожалению, в документе не нашла принципы градации уровней, потому могу только делать предположения.

PS: Недавно руководитель поручил мне задачу, которая, как я думала, вообще не относится к работе технического писателя. Я исполняю любое поручение, никогда не показывая, что мне оно не нравится, ведь на то и пришла на работу. Однако в рамках подготовки этой заметки открываю профессиональный стандарт - и надо же, оказывается, что это одно из трудовых действий согласно разделу 3.6.2 "Трудовая функция", код F/20.7, уровень квалификации 7. Воистину, молчание - золото. Работаю и исполняю поручения руководителя дальше. 🤝

#рабочее #профстандарт
👍1
✈️Прийти с нуля на позицию "технический писатель" (намеренно не называю должностью, так как официально должность - инженер) в авиацию - это была большая смелость как для меня, готовой сворачивать горы там, где надо и где не надо, и для моих руководителей, готовых обучать, рассказывать и показывать. С первого рабочего дня обрушились тонны авиационной информации, было сказано дословно: "это игра вдолгую". На тот момент наивно думала: "А что тут долгого? Здесь же донельзя просто!" Однако по факту оказалось и просто, и сложно одновременно. Просто в плане оформления документов и исправления ошибок - все же, за плечами многолетний профессиональный опыт работы с текстами, а сложно - в плане авиации: определения, процессы, базы данных и их взаимосвязь. При этом да, безумно интересно.

PS Сейчас розовые очки в плане профессиональной реализации разбились где стеклами внутрь, а где, к счастью, и стеклами наружу. Однако, как бы что не сложилось в дальнейшем, всегда буду благодарна судьбе, за то, что привела на эту стезю, руководителям, которые в меня поверили и не побоялись и коллегам, с которыми работаю бок бок. ✈️

#околорабочее
✈️В составе любого оборудования используются не только комплектующие собственного производства, но и покупные изделия. Согласно ГОСТ 2.101-2016, изделиями могут быть устройства, системы, оборудование и т. д.
Термин "покупное изделие" указан в п. 3.1.5 ГОСТ 2.124-2014 - это изделия, НЕ изготовляемые на данном предприятии. Этот же ГОСТ регламентирует все аспекты его применения.
Покупные изделия необходимо записывать в спецификацию в раздел "Прочие" (п. 4.1 ГОСТ 2.124-2014).
При необходимости оформляют протокол разрешения на применение покупного изделия (п. 4.5 ГОСТ 2.124-2014).
Протокол разрешения действителен для всех последующих стадий разработки конструкторской документации (по ГОСТ 2.103).

#покупное_изделие #ГОСТ_2_101_2016 #ГОСТ_2_124_2014
💡Когда я искала работу, руководствуясь своим обаянием ввиду отсутствия опыта, одна из компаний прислала мне тестовое задание. И первый вопрос был - что такое система. На тот момент я не смогла на него ответить и, естественно, предложение о работе не получила. Благодаря опыту работы, полученному на авиационном предприятии, несколько научилась работать с информацией. Потому недавно смогла найти ответ на данный вопрос. Итак,
Система, согласно п.1 приложения 1 ГОСТ 34.003-90, - это совокупность элементов, объединенная связями между ними и обладающая определенной целостностью.
Автоматизированная система согласно п.1.1 ГОСТ 34.003-90 - это система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций.

👆Если бы я ответила на вопросы из того тестового задания, возможно, мой карьерный путь пошел бы совершенно по другому пути. История не знает сослагательного наклонения, а потому в настоящее время отдаю себя ✈️🚁🛩️🛫🛬. В работе ГОСТ 34 совершенно не использую, однако это не мешает с ним познакомиться.

#рабочее #ГОСТ_34_003_90
👆💡В начале работы изучение ГОСТ было сравнимо с покорением горы Эверест. Их можно смело изучать 1000 и 1 ночь, но так ничему не научиться. А можно путем проб и ошибок найти собственные работающие методики (скажу прямо, до сих пор их ищу). Считаю, что в работе технического писателя навык самообразования важнее безукоризненного выполнения должностных обязанностей. Ведь если акцентироваться только на последнем, можно вместо профессионала стать простым подателем бумажек из принтера и перекладывальщиком документов электронного формата из одной папки (базы) в другую. В этом случае полностью теряется смысл предыдущего изучения профессии и упорного поиска работы.

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

#околорабочее
✈️Если вы думаете, что самолет - это летательный аппарат на подъемной тяге и с крыльями посередине, то... вы очень и очень далеки от истины! Потому что ✈️самолетами в языке XIX в. называли некоторые технические средства, которые, благодаря своей конструкции, не требовали значительного приложения усилий для своей работы.

Вот толкование слова самолет из словаря Даля: ✈️самолет - "разного рода устройство, которому приписывается быстрое движение от себя: паром на якоре посреди реки, у которого дно устроено откосом против течения так, что течение переносит паром с одного берега на другой". Другое значение - "ткацкий челн, бросаемый не с руки, а погонялкой; вообще машинный ткацкий стан".

А в современном смысле ✈️самолетом ранее называли аэроплан. Слово ✈️«самолёт» применил для обозначения управляемого аэростата в 1857 г. капитан 1 ранга Н. М. Соковнин. В значении, близком к современному, слово «самолёт» впервые в России употребил журналист и писатель А. В. Эвальд в статье «О воздухоплавании», напечатанной в 1863 г. в газете «Голос», где он предложил идею летательного аппарата тяжелее воздуха, использующего неподвижную (относительно других частей аппарата) несущую поверхность для создания подъёмной силы и архимедов винт, приводимый в движение располагающимся на борту двигателем, для создания тяги.

И все же, как понятие ✈️самолет трансформировалось от ткацкого челна до современного летательного аппарата? Какой эволюционный языковой путь прошло это слово? 🤔🤔🤔 Поиск в интернете ничего не дал, Chat GPT тоже вдруг оказался не другом... В таких случаях я становлюсь фаталистом: если будет суждено, ответ сам собой найдется. ✈️🛬🛫🛩️

#самолет #околорабочее
✈️Мои должностные обязанности в ходе работы на авиационном предприятии донельзя зарегламентированы. Каждый алгоритм, каждый этап контроля внесения изменений в документацию продуман до мелочей. ГОСТ можно изучать бесконечно, и каждый раз, при внесении очередных правок, понемножку вырастать в работе.

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

✈️Это заведующий кафедрой инженерной геодезии и картографии, который все 5 лет учебы твердил одну фразу: "Все должно быть системно". И учил нас систематизировать информацию, с нуля анализируя огромные объемы. Было очень тяжело в учении, но необыкновенно легко в бою. Прошло почти 20 лет, а полученные тогда навыки до сих пор помогают мне по жизни.

✈️Вторым человеком стал мой нынешний коллега, который мне сказал: "Каждый раз смотри на документацию так, как будто ты видишь ее первый раз. Неважно, что она уже 20 лет пишется и переделывается. Все равно смотри как первый раз". Не сразу оценила посыл этой фразы, но когда дошло...

✈️Теперь удивляюсь: почему, когда говорят, что технический писатель должен то, се, пятое, тридесятое, никто, нигде и никогда не говорит об эффекте первого раза?! 🤔🤔🤔

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

💡Ожидание: розовые пони с крылышками несут меня к техническим текстам и заветной кнопке "бабло".
Реальность: "У тебя нет образования", "У тебя нет профильного опыта", "Тебя надо год учить".

👆И это при том, что я давно на "ты" с текстами. А теперь расскажу правду. Настоящие знания нужно получать не столько на курсах, сколько из вакансий на том же ХХ.ру - смотреть требования к соискателям и пытаться получить хоть какое-то понятие о них...

Зато теперь: ✈️🛩️🛫🛬🚁📝🟰👌🤞❤️

#околорабочее
✈️📝ГОСТ - можно изучать бесконечно и каждый раз открывать что-то новое. Недавно открыла для себя ГОСТ Р 58849-2020 Авиационная техника гражданского назначения. Порядок создания. Основные положения. Последнее обновление 01.07.23 г. Что опытному специалисту давно известно, то новичку... Оказывается, безопасность полета - это конкретный термин, содержащийся в п. 3.1.4:

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

✈️воздушное судно: (п. 3.1.7) Летательный аппарат, поддерживаемый в атмосфере за счет взаимодействия с воздухом, отличного от взаимодействия с воздухом, отраженным от поверхности земли или воды.

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

В техническом писательстве есть понятие "жизненный цикл документа", отображенный в п.1.4.1 Р 50–605–80–93. Ввиду большого объема текст цитировать не буду, но суть очень похожа.

Жизненный цикл документа неотделим от жизненного цикла авиаизделия. Они рождаются вместе и "на покой" тоже уходят вместе, в момент снятия с серийного производства.

✈️Должность главного конструктора также описана в п. 3.1.9 ГОСТ Р 58849-2020.

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

#авиация #рабочее #ГОСТ_Р_58849_2020 #Р_50_605_80_93
Необычный ракурс Су-30м
📝✈️Как я работаю? Делюсь одной из методик

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

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

Правки, которые уже внесены, помечаем плюсом, которые ещё не внесены - оставляем поле пустым. Если правка не нужна, ставим минус.

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

#рабочее
🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
✈️✈️✈️✈️✈️✈️✈️✈️✈️✈️✈️✈️
Уже почти прошёл 2023 год, впереди 2024й. Хочу пожелать, чтобы следующий год стал максимально продуктивным как в работе, так и в жизни. Пусть каждый день станет маленькой историей, которая приближает к исполнению желаний и целей. Давайте вместе верить в лучшее будущее и приближать его своими руками!
🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
✈️✈️✈️✈️✈️✈️✈️✈️✈️✈️✈️✈️
✈️Как ни парадоксально, в первый рабочий день после длительного перерыва (не важно, по какой причине) не рекомендуется усердно работать. Потому сей пост - полушутка-полуправда для того, чтобы вспомнить об авиации, немного улыбнуться и подготовиться к новым свершениям.

✈️Итак, вы видите 4 картинки. На первой - оригинальное изображение самолета Як-40, взятое из интернета. Почему именно он? Да потому что так захотелось. Три остальные сгенерированы нейросетью Stable Diffusion. То ли я запросы неправильно пишу, то ли искусственный интеллект пока нуждается в укрощении, словно дикий мустанг...

✈️На второй картинке изначально был задан запрос: ЯК 40 + блокнот + карандаш, в итоге выдано то, что вы видите с подписью: The aircraft Yak-40, Detailed, Aerodrome.