Заметки технического писателя
190 subscribers
231 photos
15 videos
52 links
Технический писатель. В настоящий момент работаю в авиационной отрасли.
Download Telegram
Недавно просматривала чаты коллег и заметила одну интересную особенность. Почему-то техписам из 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
27 мая - День города Санкт-Петербурга. Я его встретила на дне рождения футбольной команды "Зенит" двумя днями ранее. Не являюсь болельщиком, так как внимание направлено на совершенно другой вид спорта. Но рок-концерт был знатный.

Скоро будет 14 лет, как я вынужденно оставила абсолютно все в родном городе и переехала в город на Неве. В прошлой жизни: школа, институт, первые 5 лет работы после института и мысли о том, что все в жизни абсолютно стабильно. Ведь на предприятии, где я работала, многие сотрудники приходили молодыми и уходили только по достижении пенсионного возраста. Думала, у меня будет также. Но недаром говорят: "Хочешь насмешить Бога, расскажи ему о своих планах". Над моими планами работать всю жизнь на одном месте и жить "как все" судьба посмеялась очень заливисто.

Я до сих пор не понимаю, кто и что для меня Санкт-Петербург, город, который разительно по климату, природе, историко-культурному контексту отличается от города моей родины. Мне некуда и не к кому вернуться в родной город - так сложилось (все родственники оттуда уехали). Но и возвращаться самостоятельно обратно не хочу, так как жизнь вторая (в Питере) тоже по-своему увлекательная и интересная, и, чувствую, я прожила ее не до конца.
3
✈️ Почему маршрут полета одного и того же рейса всегда разный? Часть 3

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

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

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

В центре снимка на фоне проливного дождя просматривается река Цирибихана на Мадагаскаре. Она протекает в западной части острова. Её часто называют "артерией" Мадагаскара из-за особого красного цвета воды. Цвет воды хорошо виден с поверхности, нежели на космическом снимке. Длина реки составляет 150 километров. Представленный снимок был сделан через иллюминатор МКС космонавтом Роскосмоса Сергеем Рязанским 28 марта в 2023 году.

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

Когда используется руководство по эксплуатации?

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

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

Какие основные разделы присутствуют в инструкции?

Введение
Перечень инструментов и материалов
Шаги и подробные инструкции
Иллюстрации и диаграммы
Предупреждения и меры безопасности
Дополнительная информация

Какие основные разделы присутствуют в руководстве по эксплуатации?

Введение
Сборка и подключение
Инструкции по использованию
Техническая информация
Предупреждения и меры безопасности
Ответы на часто задаваемые вопросы

Продолжение 10.06.2025
👌1
Накануне у меня случился очередной день рождения. Зачем я про это вообще пишу??? У меня в паспорте одна дата, фактическая (из-за переезда в Петербург и образовавшейся разницы часовых поясов) другая, на работе в этот раз отпраздновала третьей. Обычно в этот день подводят итоги, фиксируют достижения, строят планы. Все это мне категорически не интересно: я не заканчиваю свою жизнь, а потому не хочу ничего подытоживать, не отмечаю свои достижения, просто отношусь к ним буднично, без акцентирования, а планы строю тогда, когда готова это сделать вне зависимости от даты.

Мне хочется очень немногого: чтобы качественная жизнь и хорошее самочувствие у моего неизлечимо больного кота продлились как можно дольше, а лично для себя - чтобы и дальше иметь возможность жить так, как живу сейчас со всеми плюсами и минусами. Учитывая, что ранее каждые 5 лет, начиная с рождения, моя жизнь кардинально была другой, хочется немного передохнуть на островке стабильности, а потом - как получится...
5🙏1
✈️ Почему маршрут полета одного и того же рейса всегда разный? Часть 4

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

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