Заметки технического писателя
190 subscribers
231 photos
15 videos
52 links
Технический писатель. В настоящий момент работаю в авиационной отрасли.
Download Telegram
Добрая почти нерабочая среда! В голове куча планов на отдых, о которых расскажу уже после того, как сбудутся 😊 Открою лишь один маленький секрет: хочу попробовать выстроить свой мини-отдых согласно колесу баланса (на фото).

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

Мои заметки будут выходить в рабочие дни 5,6,7 мая, далее - с 12 мая.
👍5
Когда я в последний раз ездила в Москву, купила классный дизайнерский календарик с мотивационными цитатами на каждый из 365 дней в году. Но я была бы не я, если бы честно каждый день отрывала бы листочки, читала, что там написано, вдохновлялась бы. Я, которая действительно я, делает так: сначала полюбуется. Затем на 20-25 дней включает режим баннерной слепоты и по истечению времени вспоминает (интонациями фильма "Иван Васильевич меняет профессию"): "А дата на календарике не настоящая!". А после последовательно отрывает листы до настоящей даты, которая становится таковой для календаря на последующие дней 20. В итоге обнаружила мотивашку с самолетиком ✈️.

Указанная цитата никак не ассоциируется со мной и с моим мироощущением. Публикую самолетик просто потому, что это самолетик ✈️. А если цитата кому-то реально откликнулась в сердце, значит, рада была помочь!
6
В чатах и каналах моих коллег, работающих в IT-сфере, периодически встречается упоминания термина "Стайлгайд". Так как в производственной сфере этот термин не используется, переведу "с русского на русский" - это документ, где собраны пожелания заказчика относительно стиля (что понятно из названия), тона изложения, особенностей оформления и другие вопросы, для которых в целевом языке перевода нет строгих правил. Какой должна быть интонация: сдержанно формальной или непринужденно разговорной? Можно ли использовать сленг? Что делать с ценами? Придерживаться метрической или имперской системы мер? Важно ли везде одинаково оформлять даты? Переводить ли названия организаций и инициатив?

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

В качестве примеров стайлгайдов IT не единожды рекомендовали Озон и Гугл. Познакомившись с ними, теперь, как техпис, отчаянно их рекомендую. Найти стайлгайды легко по запросу в поисковой системе. По сути - это те же ГОСТ, но обязательные лишь в рамках конкретной организации. А потому вопрос к айтишникам: как у вас называется сотрудник, который проверяет написанное техническим писателем на пример соответствия стайлгайду?
👍2
В честь 80-й годовщины Победы, в период с 8 по 10 мая, в Санкт-Петербурге и Волгограде будут временно изменены авиационные позывные. В системе радиосвязи авиадиспетчеров аэропорт Пулково вновь будет называться Ленинградом, а аэропорт Гумрак – Сталинградом.

Эту инициативу предложили ветераны российской авиации для того, чтобы почтить память жителей городов и воинов, проявивших мужество в годы войны. Командиры воздушных судов объявят о проведении памятной акции по громкой связи перед вылетом, чтобы пассажиры, прибывающие или отправляющиеся из Санкт-Петербурга и Волгограда, смогли ощутить атмосферу этого события.
"Много нежных сердец, лишь в одном,
Лишь в одном мой приют и мой дом,
Всех дороже и всех нежней -
Это сердце любимой моей.
Ты люби его и ласкай,
Береги его, не бросай,
Все прости ему, все отдай
Не разбей его невзначай"

Это стихи из фронтового письма Михаила Александровича Советского, морского летчика, вовевавшего на гидросамолете МБР-2. Он погиб в 1944 году, в 26 лет. За мужество и отвагу, незадолго до гибели, стал Героем Советского союза.
Для меня праздник Победы - это праздник со слезами на глазах. Потому что люди отдавали свою жизнь за то, чтобы мы родились и жили мирно, они забыли о своих радостях, чтобы мы могли предаваться свои земным удовольствиям. Накануне я второй раз съездила во Всеволожск в музей авиации, познакомилась с историей войны на Ленинградском и Волховском фронтах. На одном из стендов был фрагмент этого письма. Уже дома я попыталась найти информацию о летчике Советском, которой, к сожалению, оказалось, очень мало.

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

Что мы, ныне живущие спустя 80 лет, можем сделать? Уважать этот подвиг и никогда о нем не забывать. С Днем Победы!
🔥31
✈️ Снимки дождя, сделанные из иллюминатора самолёта и с орбиты Земли. Часть 1

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

С такой высоты дождь выглядит как загадочное природное явление. Струи дождевого потока падают на Землю со скоростью: 10 метров в секунду. При этом грозовые тучи движутся по небу со скоростью в 25-30 километров в час.

Продолжение 19.05.2025
🔥5
Длительные выходные: полезно это или вредно? 🤔 Вчера ожидание: 🚲🚇🚲. Реальность: 🚗🚞🚗. Ах да, опять надо подстраиваться под график 🤦‍♀️. На автопилоте в состоянии зомби добралась на работу, проспав ночью всего 2 часа, где что-то попыталась сделать, причем что-то даже получилось. Все же, некоторые рабочие процессы иногда получается перевести в режим автопилота. По-настоящему проснулась только часов где-то в 20-21, когда добралась домой. Серое шерстяное животное 😺 не захотело выполнять свои функции разряжатора от рабочего дня, пришлось заправить в себя очередные 300 мл допинга под названием "чай", затем меня соблазнили подушка и одеялко, чтобы подумать о том, как «как космические корабли бороздят Большой театр» (с). Серое шерстяное притопало и даже заурчало заранее, зная, что его начнут чесать и гладить... Какие там планы на вечер, зачем я вообще что-то планировала? 🤦‍♀️🤦‍♀️🤦‍♀️

Коллеги, а как прошел ваш первый рабочий день после вторых майских?
Недавно просматривала чаты коллег и заметила одну интересную особенность. Почему-то техписам из IT, как правило, дают тестовые задания, а тем, кто стремится покорять производственные предприятия, лишних вопросов обычно не задают. Может, и задают, но в чатах коллег о таком не слышала. Более того, ни на основной работе, ни на подработках никаких тестовых не выполняла. С одной стороны, это хорошо, что не мучают лишними вопросами, с другой - а почему так? И почему в IT-сфере есть понятие менторства - когда ты платишь за знания опытному техпису, а затем пытаешься найти работу, а на производстве предпочитают учить прямо на рабочем месте? 🤔

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

На подработках на производственных предприятиях я считала затраченное время работы в часах, хотя это тоже странный показатель: одну и ту же работу, в зависимости от опыта и квалификации, можно сделать с разницей в несколько часов или даже дней. На основной работе, к счастью, планов, метрик, KPI у меня нет.

Коллеги, у кого есть показатели эффективности? Расскажите, какие?
✈️ Почему маршрут полета одного и того же рейса всегда разный? Часть 1

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

Продолжение 23.05.2025
👍2
✈️ Снимки дождя, сделанные из иллюминатора самолёта и с орбиты Земли. Часть 2

Данный снимок дождевого потока был сделан с высоты в 10 000 метров в мае 2018 года из иллюминатора самолёта. Над Тихим океаном сформировалось крупное грозовое облако, из которого идёт "стеной" сильный ливень.

Продолжение 26.05.2025
👍5
Перед майскими выходными я честно намеревалась разбить свою жизнь на сектора и пытаться достичь гармонии по всем ее аспектам. Первого мая потратила 2 часа на то, чтобы сначала придумать сектора для себя и обозначить уровни, затем на то, чтобы обозначить уровни по секторам, взятым из интернета. В итоге все скатилось к моему любимому списку: цель 1, цель 2, цель 3 и т. д. Каждая цель была подразделена на 4-8 мини-целей. И здесь началось испытание рутиной, ведь выполнять какие-то мелкие задачи - это настолько скучно, что приходится брать себя за шкирку. Сделано далеко не все, что хотелось, многое будет сделано с большим опозданием. Зато греет душу осознание, что хотя бы что-то сделано, пусть и через силу.
👍1
Чем отличается инструкция от руководства по эксплуатации. Что выбрать и когда? Часть 1

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

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

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

Пример инструкции:

1️⃣Подключите кабель к источнику питания.
2️⃣Вставьте вилку в розетку.
3️⃣Нажмите кнопку включения.
4️⃣Дождитесь, пока индикатор загорится зеленым.
5️⃣Готово! Теперь вы можете пользоваться устройством.

Пример разделов руководства по эксплуатации:

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

Продолжение 22.05.2025
👍4
Чем отличается инструкция от руководства по эксплуатации. Что выбрать и когда? Часть 2

Назначение инструкции

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

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

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

Назначение руководства по эксплуатации

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

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

Продолжение 27.05.2025
👍5
✈️ Почему маршрут полета одного и того же рейса всегда разный? Часть 2

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

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

Продолжение 30.05.2025
👍1
✈️ Снимки дождя, сделанные из иллюминатора самолёта и с орбиты Земли. Часть 3

Этот великолепный снимок с дождём и молнией сделала американка Джина Хайямс через иллюминатор самолёта 26 июля 2014 года. Как утверждают многие фотографы: фотографирование молнии является довольно сложным процессом. Для этого нужно ставить большое время выдержки камеры, а также проявлять терпение, чтобы "поймать" молнию в кадр. Но Джине Хайямс этого не потребовалось.

Когда из-за непогоды самолёт кружил около аэропорта города Денвера в США, пассажирка взяла свой смартфон, поставив камеру в режим серийной съёмки, сделала такое зрелищное фото.

Продолжение 2.06.2025
🔥3👍1
Чем отличается инструкция от руководства по эксплуатации. Что выбрать и когда? Часть 3

Различия между инструкцией и руководством по эксплуатации


Инструкция:
Простые и краткие указания по использованию продукта
Фокусируется на выполнении конкретных задач
Часто содержит шаги и диаграммы для выполнения операций
Обычно предоставляется в комплекте с продуктом
Может быть написана в виде одной страницы или набора отдельных инструкций

Руководство по эксплуатации:
Подробное и комплексное руководство по эксплуатации продукта
Охватывает все аспекты эксплуатации продукта
Содержит описание функций, настроек и режимов работы продукта
Может быть приобретено вместе с продуктом или отдельно
Обычно содержит несколько страниц информации

В целом, инструкция и руководство по эксплуатации оба предоставляют пользователю информацию о использовании продукта, но отличаются своим объемом, детализацией и специфичными требованиями к пользователям.

Продолжение 28.05.2025
Чем отличается инструкция от руководства по эксплуатации. Что выбрать и когда? Часть 4

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

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

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


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

Продолжение 3.06.2025
2