✈️Навыки, необходимые техническому писателю. Часть 1✈️

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

Основные навыки, которые понадобятся, чтобы стать хорошим техническим писателем:

✅Технические знания и желание учиться

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

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

✅Пользовательские исследования и тестирование

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

#рабочее

✈️Навыки, необходимые техническому писателю. Часть 2✈️

✅Понимание аудитории

Чтобы писать для конкретной аудитории, необходимо ее понимать. Это гарантирует, что вы пишете контент, который отвечает ее потребностям и помогает достичь желаемого результата. То, что является естественным или общеизвестным для вас, может не быть таковым для вашего читателя. Возможность представить себя новичком и писать, имея в виду такого человека, очень поможет.
‍
✅Умение оставаться объективным и внимательным к деталям

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

✅Планирование и организация

Прежде чем начать писать, нужно проделать большую подготовительную работу — нужно четко определить объем работы, провести предварительное исследование и составить план проекта.

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

✅Редактирование

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

#рабочее

30 июня 2024 года китайский AG600 завершил испытания на критическую нагрузку

Разработка самолета-амфибии AG600, проводимая корпорацией AVIC, постепенно приближается к финалу. Очередной «высотой», взятой китайскими инженерами, стало завершение наземных испытаний на критическую нагрузку, пройдя 259 тестов за 28 дней.

AG600 Kunlong, оснащенный четырьмя турбовинтовыми двигателями WJ-6, может похвастаться максимальной взлетной массой 53,5 тонны.

AG600 построен вокруг однокорпусного фюзеляжа в форме летающей лодки. Он может работать на водной акватории размером не менее 1500 на 200 м и глубиной 2,5 м, преодолевая волны высотой до 2 м.

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

Проект AG600 входит в число трех наиболее крупных авиационных программ Китая, наряду с военно-транспортным самолетом Y-20 и авиалайнером C919.

✈️Как устроен самолёт. Разбираемся вместе. Часть 17

Схема устройства турбореактивного двигателя: 1 — входное устройство; 2 — компрессор; 3 — камера сгорания; 4 — турбина; 5 — выходное сопло

#как_устроен_самолет

✈️Как улучшить навыки технического писателя✈️

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

✅Читать

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

✅Пройти курсы

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

✅Создавать системы и процессы

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

✅Улучшите свои навыки работы с людьми

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

✅Запрашивайте и реализуйте обратную связь

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

✅Присоединяйтесь к ассоциации или группе единомышленников

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

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

#рабочее

Что такое ТУ и в чем отличие от ГОСТ🤔

Технические условия (ТУ) представляют собой документ, который устанавливает требования к производству, упаковке, транспортировке, хранению и использованию определенной продукции (услуги, работы). Если простыми словами, то это техническое описание всего процесса изготовления товара на конкретном предприятии, его характеристик, как он должен быть упакован и в каких условиях можно хранить и перевозить, а также как проверить его качество.

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

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

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

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

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

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

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

✅ТУ;
✅экспертное заключение технического комитета по стандартизации на ТУ;
✅документ об утверждении ТУ организацией (при наличии);
✅пояснительная записка, содержащая сведения о разработчике, правообладателе, области применения, объекте стандартизации, кодах Общероссийского классификатора стандартов ОК (МК (ИСО/ИНФКО МКС 001-96) 001-2000 и Общероссийского классификатора продукции по видам экономической деятельности ОК 034-2014 (КПЕС 2008), дате утверждения ТУ;
✅информация об использовании в ТУ объектов патентного права;
✅подписанное соглашение об опубликовании и условиях распространения ТУ.

После регистрации у ТУ появляется специальный номер, и запись о регистрации появляется в государственном реестре. Владельцем ТУ является компания, и она может продавать (передавать) другим производителям право на его использование.

Начинаю цикл заметок о технических писателях в разных отраслях. Первая на сегодня - о технических писателях в авиации

✈️Кто такие авиационные технические писатели?✈️

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

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

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

✈️Как устроен самолёт. Разбираемся вместе. Часть 18

Реактивный прямоточный двигатель

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

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

Схема устройства реактивного двигателя: 1 — встречный поток воздуха; 2 — центральное тело; 3 — входное устройство; 4 — топливная форсунка; 5 — камера сгорания; 6 — сопло; 7 — реактивная струя

#как_устроен_самолет

✈️Руководство по эксплуатации✈️

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

Понятие руководства по эксплуатации

Содержание термина «руководство по эксплуатации» принято трактовать в соответствии с положениями ГОСТ 2.601-2006 «Единая система конструкторской документации (ЕСКД). Эксплуатационные документы». Указанный национальный стандарт определяет данное руководство как важный документ, в котором содержится исчерпывающая информация о характеристиках продукта, его конструкции и принципах работы, правилах безопасной эксплуатации и осуществления работ с применением данного изделий.

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

Статус руководства по эксплуатации в ряду прочих технических документов

ГОСТ 2.601-2006 относит руководство по эксплуатации к разряду эксплуатационных документов наряду с инструкцией по монтажу, паспортом изделия, ведомостью наличия прилагаемых запчастей и проч. Таким образом, на данное руководство распространяются соответствующие правила Единой системы конструкторской документации (ЕСКД). В частности, это относится к положениям ГОСТ 2.610-2006 «Единая система конструкторской документации. Правила выполнения эксплуатационных документов».

#руководство_по_эксплуатации

✈️Применение руководства по эксплуатации✈️

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

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

Дополнительно:

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

Кроме того, оно может потребоваться для получения ряда разрешительных документов:

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

Таким образом, разработка РЭ – это ответственная процедура, к которой компании-производителю необходимо подойти с должной серьезностью.

#руководство_по_эксплуатации

Хорошо там, где нас нет - избитая донельзя цитата, но именно так мне иногда думается, когда читаю чаты коллег. Не помню, где подсмотрела фразу: "Хорошо там, где есть я". Может, это ощущение возникает потому, что я не в IT, а на производстве? Или потому, что у нас нет продвинутых технологий вроде Docs as Code, Markdown и пр. 🤔✈️ Наверное, надо учиться чувствовать себя хорошо в любом месте, ибо "все свое ношу с собой", иначе нет смысла кочевать с предприятия на предприятие, ведь и там пытливым взглядом что-то обязательно найду...

Мне периодически хочется уйти, но каждый раз задаю себе вопросы: зачем? от чего уйду? что приобрету? И понимаю, что не могу четко и достоверно ответить на них. Я не фанат своего предприятия, где работаю сейчас, но, по крайней мере, там отлаженная до автоматизма система взаимопомощи и наставничества, при должном желании и упорстве можно заниматься саморазвитием. Ни с одной проблемой я не оставалась один на один. Был опыт работы (не техписом), когда не было никакой адаптации, и каждый был сам по себе. Это и держит пока...

#рабочее

🚀🛸Кто такие технические писатели в аэрокосмической отрасли?🛰️

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

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

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

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

✈️Как устроен самолёт. Разбираемся вместе. Часть 19

Системы бортового оборудования

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

На рисунке: Часть бортовой системы электроснабжения самолета: преобразователь тока

#как_устроен_самолет

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

✈️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👨‍💻

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

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

Независимо от размера компании, работающей в сегменте «бизнес для бизнеса» (B2B), «бизнес для правительства» (B2G) или «бизнес для потребителя» (B2C), каждая компания подвержена риску кибератаки. Таким образом, крайне важно иметь план кибербезопасности для противодействия угрозе киберпреступников. С ростом удаленной работы из-за глобальной пандемии киберугрозы возрастут как никогда, поскольку хакеры нацеливаются на рабочую силу, неподготовленную к рискам безопасности, связанным с работой из дома. Это своевременный пример того, почему крайне важно проявлять бдительность и готовиться к постоянной борьбе с киберугрозами.

Что такое кибербезопасность?

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

Чтобы подготовиться к кибератаке, предприятиям следует сначала узнать о различных типах киберугроз. Помните, что существует множество типов киберугроз; перечисленные ниже угрозы являются наиболее распространенными.

Типы киберугроз

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

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

#кибербезопасность

Люблю читать каналы своих коллег - технических писателей. С удивлением наблюдаю, что 90% их контента - это их живые эмоции, рассказы, как они себя чувствуют на работе, как отдыхают, как живут. Я же акцентировала внимание на том, как работать техписом, изучая российские и западные источники и на рассказах о самолетах. Уже готовы интересные материалы, которые лежат в "запланированных".

У меня получился канал - на 50% справочник по работе, на 45% - про самолеты, на 5% - лично обо мне и моих ощущениях.

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

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

💻Кто такие технические писатели API?🖥️

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

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

Роль технического писателя API заключается в создании всеобъемлющей, удобной для пользователя документации, которая помогает разработчикам использовать API. Эта документация обычно включает в себя справочные руководства, учебные пособия, примеры кода и передовые практики. Технические писатели API гарантируют, что разработчики смогут легко интегрировать API, минимизируя ошибки, повышая производительность и способствуя позитивному опыту разработчиков.

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

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

✈️Как устроен самолёт. Разбираемся вместе. Часть 20

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

К авиационному оборудованию относится, прежде всего, электрика, в том числе системы энергоснабжения, светотехническое оборудование, системы управления силовыми установками (двигателями машины), системы кондиционирования, автоматические противопожарные средства, противообледенительные системы.

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

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

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

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

#как_устроен_самолет

Вот такие ролики повышают личную самооценку. И хотя он совсем не о техническом писательстве, но по сути в точности отображает нашу профессию. 📝➕✈️🟰❤️

https://www.youtube.com/shorts/HzuTGrqeLwM

👨‍💻Как технические писатели повышают кибербезопасность (объяснение). Часть 2👨‍💻

Как киберугрозы влияют на ваш бизнес?

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

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

Как технические писатели по кибербезопасности могут помочь бизнесу?

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

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

#кибербезопасноть

Может ли любимая работа надоесть? Нужно ли соблюдать work-life-balance, и если да, то зачем? Каковы его критерии? С 5-дневкой в большом городе, когда на дорогу уходит минимум 3 часа, мозги работают на износ, чтобы найти способы оптимизации дефицитного времени, не потеряв качества жизни и не выгорев дотла - птицей феникс я не рождалась. А как вы соблюдаете этот баланс?

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