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

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

Case studies - это отраслевое описание продукта, отражащее варианты применения электронного устройства в той или иной сфере, например, особенности применения какой нибудь разработанной антенны в сетях 5g или в какой нибудь АФАР.

White paper - это нерекламный документ рекламного характера. Похоже на case studies , но в white paper больше технической рекламы, всяких исследований рынка, трендов и тд.
👍4
Новинки авиации: 5 самолетов, на которых мы скоро сможем летать. Часть 4 ✈️

Airbus A321XLR: сверхдальний, сверхкомфортный

По словам производителя, Airbus A321XLR, который будет запущен в следующем году, предлагает эквивалент «широкофюзеляжного комфорта на дальних рейсах» в меньшем размере (он может похвастаться более широкими сиденьями и большими багажными полками). Самолет сможет совершать беспосадочные перелеты на расстояние до 8700 км (что на полторы тысячи км дальше, чем Boeing 737 или другие узкофюзеляжные модели). У этого борта есть третий топливный бак, который позволяет удвоить время полета по сравнению с другими моделями аналогичного размера. Airbus заявляет, что благодаря передовым двигателям сможет снизить расход топлива почти на 30 % – что ставит его в один ряд с самыми эффективными широкофюзеляжными самолетами.

Продолжение 31.10.24
Телефон сегодня не роскошь, а средство связи. Но всемирную паутину на то и назвали так, что она затягивает. Для меня долгое время было большой проблемой отложить телефон вовремя. Вечером с ним засыпала, утром просыпалась в обнимку с ним. Для меня телефон был как водка для алкоголика… Оружие против телефонного змия оказалось до гениальности простым: небольшая пластиковая корзинка, в которую вместились: смартфон с кулером, кнопочный телефон, деревянная подставка, текстовыделитель, с которым читаю книги, зажигалка для свечей. Зарядки лежат в отдельном месте. Теперь на поверхности тумбочки царит идеальный порядок, а корзинка убрана во внутреннюю полку. С тех пор домашний время сёрфинг по волнам дзена и прочего уменьшилось в разы. У кого проблемы с телефоном, как у меня, попробуйте также!

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

#лайфхак
Как создать эффективные инструкции? Часть 6 ✈️

Как могут помочь основные данные

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

Mitsubishi Regional Jet

Mitsubishi Regional Jet (MRJ) — это японский аналог российского самолета МС-21 или SSJ-100, который выпускается японской компанией Mitsubishi Aircraft Corporation. Этот самолет разработан специально для региональных перевозок и может перевозить до 90 пассажиров на расстояние до 3000 км. Так же, как и во многих современных «регионалах», в MRJ используются новейшие двигатели Pratt & Whitney PW1200G. Недорогие двухдвигательные низкопланы (к коим относятся и российские МС-21 и SSJ-100) широко востребованы у островных государств. Такие самолеты используются для небольших перелетов протяженностью до 1500−2000 километров.

Продолжение 6.11.24
Закончилась предварительная подготовка РЭ на американском английском языке. Технические термины уже подсказывает Chat GPT, всю грязную работу выполнила московская компания-переводчик, осталось только оформить по ГОСТ. Я не буду приводить термины здесь, так как они, в зависимости от отрасли даже внутри авиации, могут звучать совершенно по-разному.

А из оформления по ГОСТ отмечу:

 термины и определения - сначала на русском (непереводимые), затем на английском;
 убираем все упоминания о ГОСТ, ОСТ и прочих российских стандартах;
 буквенное обозначение децималов убираем, циферное - оставляем.

#рабочее
👏1
Новинки авиации: 5 самолетов, на которых мы скоро сможем летать. Часть 5 ✈️

Boom Supersonic: в два раза быстрее

Перелеты со скоростью, превышающей скорость звука? Безусловно, это заставит сердечки путешественников биться чаще. Денверский стартап Boom намерен начать испытательные полеты своего самолета Overture уже в 2025 году. Недавно Boom стал партнером United Airlines: авиакомпания пообещала выделить 3 миллиарда долларов на первоначальный заказ на 15 бортов Boom Supersonic. Самолеты будут способны летать со скоростью почти вдвое превышающей скорость звука. Правда, скорее всего, скорость этих судов при полетах над землей будет ограничена дозвуковой (примерно 1120 км в час).
🤩1
Сейчас нейросети могут все. Даже находить выжимки из актуальных версий ГОСТ. Вчера мне захотелось перевести анлийское слово, в итоге набрела по просторам интернета вот сюда: https://gostassistent.ru/doc/5cc007d1-5712-4841-beb2-bec307b6e3a8. Кому интересно - посмотрите приложение В. В настоящий момент мне из него ничего не пригодилось, а в будущем может быть все. А в целом авиационные термины хорошо переводит нейросеть Midjourney. Новые технологии тихой сапой проникают и в наше донельзя зарегулированные и забюрократизированные рабочие процессы. 😊✈️

#рабочее
🔥4
Всем привет! Все в субботу на работе? Всю неделю я всем и каждому ныла: "Не хочууу в субботу на работу", "Не забыть бы про нее и не прогулять". Даже большой будильник завела ради сего знаменального события. Но сегодня... Сегодня с легкостью встала, вышла из дома на 20 минут раньше обычного, на душе удивительное спокойствие. Впервые за несколько месяцев поехала на работу на утренней развозке вместо такси. Аболютно безоблачное небо сменилось снегопадом, сейчас опять чуть проясняется.

Чувствую, завтрашний выходной после 6-дневного марафона будет выглядеть так: два тюленя (я и кот) покоряют просторы кровати. 😊✈️

#рабочее
👍2🥰1
Что такое написание инструкций? Часть 1✈️

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

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

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

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

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

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

#рабочее
👍1
Современные пассажирские самолеты российского и зарубежного производства. Часть 6✈️

Bombardier Cseries

Одной из ключевых особенностей самолетов Bombardier Cseries является его двигательная установка. Самолет оснащается современными двигателями Pratt & Whitney PW1500G, которые отличаются высокой тягой и экономичностью. Другое название самолета — Airbus A-220.

Продолжение 12.11.24
2🤩1
Мне повезло сравнить взаимодействие технического писателя и разработчика на разных предприятиях благодаря подработкам. Если самую первую получила благодаря полному доверию работодателей, пришедших на мой аккаунт одного из сервисов, то последующие примерно так: "Где вы работаете? Авиационное предприятие?! Круто! Высылаем ТЗ..."

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

Благодаря разнообразию опыта у меня выработались личные критерии взаимодействия с разработчиками:
полное доверие, желание слушать и слышать друг друга;
быстрые и оперативные ответы (был заказчик, который отвечал от недели до трех) на любые вопросы, даже на самые дурацкие вопросы;
сколько надо - столько и вычитываем документ. Хоть 5, хоть 25 раз. На авиационном предприятии в прямом смысле 25 раз документ никогда не читали, но при подготовке с нуля получается более 10 раз точно. Требование сделать технически сложный документ идеально с первого - второго раза... даже не знаю, как это назвать...;
возможность лично протестировать прибор или программу - без этого невозможно правильно выстроить коммуникацию с разработчиками.

А как работаете вы? Требуют ли у вас сразу идеальный документ? Есть ли план/норма, сколько документов/по времени нужно сдавать? Поделитесь в комментариях 😊✈️

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

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

#мысли_вслух #околорабочее
💯4
Что такое написание инструкций? Часть 2✈️

Каковы преимущества услуг по написанию инструкций?

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

2️⃣Всестороннее и структурированное руководство: технические писатели создают руководства с хорошо структурированным подходом, гарантируя, что информация логически перетекает от одного шага к другому. Они включают в себя важные детали, пояснения и советы по устранению неполадок, предоставляя пользователям всеобъемлющее руководство по эффективному использованию продукта. Этот всеобъемлющий подход снижает потребность в дополнительной поддержке и запросах.

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

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

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

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

#рабочее
👍1
Современные пассажирские самолеты российского и зарубежного производства. Часть 7✈️

Самолеты будущего

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

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

Продолжение 19.11.24
🤩1
Один день из моей жизни (описание и хронометраж примерные)

6:00 Подъем. Эх, жалко, что до будильника не проснулась, личного времени было бы больше. Рука тянется к диммеру, включаю бра. Рядом нечто серое, пушистое, иногда мяукающее. У меня два часа, чтобы переделать личные дела. Начинаю с первого - притянуть к себе нечто. При поглажке срабатывает автовключение мурлыкания. Немного неги, затем душ, чай, завтрак.

6:30 Можно почитать книжку, позаниматься гимнастикой, потупить в телефон. Нечто открыло свои глаза янтарного цвета, сонно посмотрело и плюхнулось дальше спать. Не мешаю.

8:00 Выход из дома. 30 минут пешком до метро, ибо пробки не дают шанса приехать быстрее, чем притопать ногами. Чтобы не было скучно, включаю музыку в наушниках.

8:30 Пока добираюсь до работы, играю несколько партий в шахматы и все больше задумываюсь о том, чтобы взять уроки у тренера. Надоело проигрывать даже тогда, когда соперник явно напрашивался на мат.

9:30 Пропуск подтвердил, что на сегодня работу все же не прогуливаю. Первая рабочая кружка чая (а их будет 5-6 за 8 часов). Обсуждение рабочих вопросов сопровождается шутками, иначе можно с ума сойти от количества правок, которые, как полчища тараканов, атакуют с каждой новой версией документов.

18:25 Сижу в развозке. Можно из промзоны выбраться и самостоятельно, но до того лень это делать без велосипеда...

18:35 Опять шахматы по дороге домой. Я уже поняла, какие у меня способности к игре. Не стать мне не то, что гроссмейтером, даже третьеразрядником (в детстве сдавала на 4й).

20:00 Бодрый котик ждет, когда ему погладят животик. Автоурчание прилагается. Эта обязаловка длится не более 5 минут, затем каждый расходится по своим делам. Это я так думала. На самом деле, кто-то хочет играть. А кто-то сильно проголодался после работы, и в итоге веревочка в одной руке и яблоко в другой.

22:30 Сон...

#околорабочее
6
Согласно п. 5.2.3 ГОСТ 2.105-2019 в тексте документа не допускается применять обороты разговорной речи, техницизмы и профессионализмы. Если первое понятно, то второе и третье стало новостью - раньше я не знала таких слов. Потому обратилась к поисковику:

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

Профессионализмы — это слова или выражения, которые употребляются в профессиональной речи, то есть в речи людей определённой профессии. Пример: баранка (руль автомобиля у водителей), шапка (заголовок статьи у журналистов).

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

#ГОСТ_2_105_2019
У меня нет вопросов, как лучше писать документы: по ГОСТ, внутреннему стандарту компании или в свободной форме? Любая работа всегда для чего-то нужна. Зато есть вопрос, какая работа интереснее. Лично мне больше всего понравилось писать руководство по эксплуатации на программу. Мне дали к ней и демо, и пользовательский доступ. Сидишь, нажимаешь кнопочку, видишь действие на компьютере и описываешь. Кайф. Жестких требований не было, но тогда самостоятельно нашла РД-50 и взяла его за основу.

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

#мысли_вслух #околорабочее
3
Это произошло в четверг. После дождичка как раз. Действующие лица: Разработчик (Р) и я (Я).

Р: Мы скоро будем писать документ по ГОСТ РВ. Надо у нормоконтроля попросить учтенные экземпляры.
Я: Хорошо (про себя: ойййй, надо же вроде служебную записку писать, а я не помню, как).
P: Это будет в ворде (скорее всего).
Я: 😔😔😔 🙈🙈🙈я к TG Builder привыкла, несмотря на его периодические заскоки. Там очень многое автоматизировано.
Р: Это еще не все. Никто на предприятии по этому ГОСТ еще не писал. Мы будем первыми.
Я: 🙈🙈🙈 Ничего, напишем (про себя: 😱😱😱!!!).
P: Пока время есть, надо ГОСТ немного почитать, чтобы понимать, как нам работать.
Я: Ок, первопроходцы будем (про себя: 🤬🤬🤬, даже списать не у кого. Зато потом народ будет списывать у меня!).
Я: Что-то нам везет второй раз быть первопроходцами (в первый раз в 2023 году я первая на предприятии обновляла документ по обновившемуся ГОСТ)
Р:😊😉

Послесловие (про себя): "Спасибо тебе, дорогой мой человечек! Подкинул мне работенки!"

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

#рабочее
👍4
Современные пассажирские самолеты российского и зарубежного производства. Часть 8✈️

QueSST

Проект QueSST (Quiet Supersonic Technology) — это совместная инициатива NASA и компании Lockheed Martin, направленная на разработку более тихих и удобных для пассажиров сверхзвуковых самолетов. Главной целью проекта является создание самолета, способного преодолевать звуковой барьер при скорости около 1500 км/ч, что позволит сократить время полетов между различными городами в несколько раз.

Главным новшеством в конструкции самолета QueSST является форма крыла самолета и другие аэродинамические особенности конструкции, предназначенные для уменьшения звуковой ударной волны. По предварительным данным, в основе силовой установки будет использован двигатель от боевого истребителя F-16.

Boom

Boom представляет собой первый в мире 55-местный самолет, который способен развивать скорость в 2,2 раза больше скорости звука и при этом разарабатывается не крупной государственной компанией, а частным стартапом. Это означает, что пассажиры смогут добраться из Нью-Йорка в Лондон всего за 3,5 часа, вместо обычных 7−8 часов полета, что значительно сократит время в пути. Самолет Boom оснащен технологически новыми двигателями, которые позволяют сократить вредные выбросы CO2 в 30 раз.

Двигатель Symphony («Симфония») должен будет создать необходимую тягу для полетов на скорости до 1,7 Маха. Благодаря таким характеристикам расстояние от Лондона до Нью-Йорка можно будет преодолеть за менее чем 3,5 часа. Первый испытательный полет намечен самолета намечен на 2027 год, а сертификация типа — на 2029-й. Коммерческая дальность полета самолета — 10000 километров.

D-SEND 2

D-SEND 2 — это легкий одномоторный самолет, разработанный японской компанией Aero Asahi Corporation и аэрокосмическим агентством JAXA. Он был создан для использования в качестве легкого воздушного транспорта и для выполнения задач в области геодезии и картографии, а также для патрулирования и наблюдения, однако позднее создатели решили построить и версию для коммерческих перелетов.

Максимальная скорость полета самолета должна составить порядка 1,5−2М (2000−2500 километров в час), однако главной сложностью для японских авиаконструкторов в данный момент является создание двигателей. Даже крупные коммерческие компании вроде Pratt&Whitney или Rolls Royce пока не создали необходимых таким самолетам агрегатов. Для этого самолета пока создан полноразмерный макет и часть системы механизации крыла, однако полноценное коммерческое применение машины пока под вопросом.
1
Как я делаю документы для сдачи в архив? Думаете, по уши в ГОСТ закопалась? На самом деле все гораздо проще, чем кажется:

1️⃣ Беру 33 буквы русского алфавита и 26 букв английского алфавита. Миксую аки диджей музыкальные композиции.
2️⃣ Становлюсь Госпожой текстов, применяя к ним повелительное наклонение. Нещадно предложу и суффиксую слова. Причащаю и деепричащаю предложения. Особо ретивые - сложноподчиняю. Удлиняю и укорачиваю тире. Ни один символ никуда от меня не денется. Подчиниться моим рукам посредством клавиатуры придется всем!
3️⃣ На выходе получаются отредактированные предложения, которые радуют и глаз, и сердце.

Ничего сложного!

#рабочее
👍3🔥1