«Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь.
Профессия технический писатель: чем занимается и как проходит типичный рабочий день
#Кем_стать: техническим писателем Много знать и доходчиво излагать свои мысли, уметь писать и одновременно разбираться в технике и технологиях, чтобы сложные вещи объяснить простым и понятным языком – работа технического писателя Работа эта стоит дорого. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. В Новом здании Российской национальной библиотеки (Московский пр., д.165 к.2) начала работу выставка «Затеси» Виктора Астафьева», приуроченная к 100-летнему юбилею русского писателя и драматурга. Опыт работы в аналогичной должности (или инженером – электроником) от одного года.
Кто такие технические писатели и зачем они нужны в команде
| День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽ | девушка при исполнении, а в свободное время - поэт. |
| Технический писатель | Полчаса смеялся, когда некая hbnf назначила (в философтовском форуме) 1 апреля Днем технического писателя. |
| Новости Санкт-Петербурга - главные новости сегодня | ФОНТАНКА.ру - новости Санкт-Петербурга | найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. |
| Сузунская централизованная библиотечная система | Новости | Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. |
День писателя
Всемирный день писателя — 3 марта! Писатели — люди, которые создают художественные литературные произведения разных жанров, предназначенные для широкой аудитории читателей. Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными Интересные факты об известных писателях: Настоящее имя Корнея Чуковского — Николай Васильевич Корнейчуков. При рождении он получил фамилию матери, но с первой же статьи стал подписываться псевдонимом Корней Чуковский.
Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами.
Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе. Даже этот рассказ о себе мне сложно писать.
Я отучился год на журфаке, а потом перешел в вышку на менеджмент. Оба образования мне пригодились, потому что со временем я стал лидом. В работе техписа мне нравится упорядочивание — из страшного сумбурного текста делать стройный и понятный. Кроме того, сейчас я параллельно выступаю как бизнес- аналитик для небольшой команды разработки. Опыт техписа там тоже пригодился, потому что приходится много писать требования и другую проектную доку. Можно сказать, что прямо вот пишет технический писатель значительно меньше, чем собирает, анализирует, общается, уточняет. Очень дипломатичная профессия, в общем :- Вопросы, которые могли остаться Разве не лучше, если писать будут разработчики?
Нет, не лучше, хотя часто именно так и происходит. Во-первых, это отнимает время разработчика, во-вторых, он не стремится сделать понятно, а пишет на своём языке, в-третьих, многие вещи ему кажутся простыми, понятными и очевидными и он не считает нужным даже упоминать их. Между тем для пользователя такие мелочи могут оказаться дремучим лесом. А если технический писатель ошибся? Документация проходит контроль качества в отделе тестирования, как и весь комплекс программного обеспечения или инженерных решений. Однако всем свойственно ошибаться — и здесь уже компания оценивает критичность ошибки и выстраивает модель безопасности технической документации например, неправильно описанная функция в ERP-системе может не повлечь урон, а вот ошибка в мануале к банковскому или инженерному ПО может стоить слишком дорого. Технический писатель — это технический или писатель?
И то и другое, поскольку это взаимодополняющие качества, делающие специалиста уникальным. Думается, что технические писатели — это одни из тех, кого долгое время не смогут заменить даже самые умные нейронки, поскольку за выдачей контента стоит огромная синтетическая и аналитическая работа, основанная на знании ПО, архитектуры и процессов.
То есть место для общения документаторов, которое со временем может стать нашим общим профессиональным «домом». По формату — это круглый стол в виде вебинара.
То есть, участвовать смогут, как обычно, все желающие, независимо от города и даже страны. Участие в наших встречах бесплатно. На первый раз у нас есть ограничение по количеству участников — 30 человек. Поскольку, по нашему опыту, мероприятие посещают не все зарегистрировавшиеся участники, мы примем больше заявок — в качестве эксперимента мы остановим регистрацию на 50 участниках.
Возможно, что вы зарегистрируетесь, но не попадёте на вебинар. Просим правильно понять этот момент и дождаться записи, которую мы обязательно выложим на сайте, а общение можно будет продолжить в комментариях на сайте и в соцсетях. Присоединяйтесь к нам всей компанией, но по возможности с одного компьютера, чтобы оставить больше свободных мест! Первый сбор На первый Доквариум мы приглашаем вас в четверг 28 июля, в 16:00 по московскому времени.
Ориентировочно мероприятие займёт 2 часа.
Мы живем в век высоких технологий, поэтому сфера IT — одна из наиболее развивающихся в современном мире. Впервые сталкиваясь с каким-нибудь новым устройством и открывая инструкцию по пользованию, вот здесь мы и видим работу технического писателя technical writer , задача которого — донести до простого пользователя сложную техническую информацию понятным, «человеческим» языком. И то, будет ли информация из справки нам полезна, а в конечном итоге — каково будет наше впечатление о новом продукте, во многом зависит от квалификации технического писателя. Некоторые скажут, что они, дескать, и не писатели вовсе, так — просто инструкции составляют.
И будут неправы.
Яндекс Образование
Технические писатели. Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия Andrei Serikov in Технические писатели. Дневник писателя Ф. М. Достоевского. Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации.
Один день из жизни технического писателя. Среда.
Контролируемые экзамены снижают риски, связанные с репутацией и организационными расходами, а также повышают качество компетенции сотрудников и студентов. ProctorEdu Компания помогает образовательным учреждениям, предприятиям и бизнесу проводить достоверные онлайн-тестирования, снижать организационные расходы и достигать KPI, предоставляя передовую систему с полностью автоматизированным, асинхронным и синхронным прокторингом. Программное обеспечение для онлайн-наблюдения, протоколирования и оценивания поведения пользователей при прохождении значимых онлайн-мероприятий экзаменов, тестирований Подробнее Ведущий разработчик технологий для корпоративного онлайн-обучения в секторе крупного и среднего бизнеса. Решения одобрены Минкомсвязи России и входят в единый реестр отечественного программного обеспечения. Помогает автоматизировать адаптацию стажеров, обучать сотрудников дистанционно, проводить онлайн-тестирование и сертификацию, измерять эффективность обучения в реальном времени iSpring Suite Простой и мощный конструктор онлайн-курсов, видеолекций, тестов и еще 20 типов материалов обучающего контента.
У него есть макеты в «Фигме» и примерный флоу процесса. Выглядит так, будто для полноценной документации этого недостаточно. Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст. Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно. Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру. Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям. Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются. Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель. У разработчиков есть код-ревью. У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной. И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай». Как понять, что работа мне подходит Возьмите приложение любимого банка и напишите инструкцию к какому-то простому процессу. Например, как оплатить мобильную связь. Покажите эту инструкцию друзьям или родителям, попросите проверить и попробовать пополнить баланс, следуя ей. Если инструкция сработала — поздравляю, это прекрасный старт, вы готовы к тестовым заданиям. Помониторьте вакансии для технических писателей без опыта и запросите тестовое задание. Вас попросят описать реальный кейс или подготовить простую инструкцию к бытовым действиям или вещам. Однажды мне дали задание: написать инструкцию к кошке. Пожалуй, это было самое милое тестовое. Я описывала кошку как самораспаковывающуюся систему. Подготовить платформу для установки и выбрать источник нужно заранее.
Источник В целом мы видим, что разработчики читают документацию, но большинство сталкивались с проблемой: её не было или она была неполной. Плохая документация — это неоправданно дорого для компаний. Особенно, если она к продукту, которым пользуются многие. За последние четыре года не раз видела случаи, когда технический писатель переписывал инструкцию и экономил часы и дни разработчиков. Например, техписатель понятно переписал онбординг, который прошли 500 человек. Это заняло у них 3 дня, а не 5. Оставшиеся 8000 часов можно потратить на разработку фич или ещё что-то полезное для компании, ведь теперь им не надо писать вопросы в чат поддержки. Что должен знать и уметь технический писатель? Это тоже зависит от компании, продукта и существующих задач, но мы с вами обратимся к Хабр Карьере и посмотрим, что требует рынок. Есть почти во всех вакансиях в той или иной мере. В любом случае знание ГОСТ сильно облегчает работу и дарит навык структурирования. Навыки сбора и анализа информации. Навыки сбора и анализа, а также описания требований — да, с требованиями техническим писателям приходится работать часто, и там есть серьёзные нюансы сбора, агрегации и «просеивания» собранной информации. Способность работать структурировать, перерабатывать с большими объёмами информации — и с каждым годом всё больше. Аккуратность, внимание к деталям. Умение писать легко и понятно — пользователи разные, и информация должна быть доступная каждому. Отличное знание русского языка. Знание английского языка — как значительное преимущество, а часто и строго обязательное требование. Мария Смирнова О себе: деловой телеграм Есть расхожая фраза про то, что технические писатели — это «переводчики с разработческого на пользовательский». При всей её заезженности и радикальности я скорее склонна с этим тезисом согласиться. Не в последнюю очередь из-за того, что я сама не только технический писатель, но и переводчик. Перевод для меня — это упражнение, похожее на сборку конструктора или паззла, решение интеллектуальной задачки. Абсолютно то же самое я нашла и в техническом писательстве. Прелесть этой работы в том, что здесь можно применять творческий подход, оставаясь в чётко очерченных рамках и решая конкретную задачу. А именно на стыке этих двух методов и происходит настоящая магия. Как говорила матерь всех переводчиков Нора Галь, «переводить надо не слово, не букву, а дух и смысл». И я верю в то, что этот принцип должен лежать в основе любой работы с текстом, особенно в работе технического писателя.
Возможно, что вы зарегистрируетесь, но не попадёте на вебинар. Просим правильно понять этот момент и дождаться записи, которую мы обязательно выложим на сайте, а общение можно будет продолжить в комментариях на сайте и в соцсетях. Присоединяйтесь к нам всей компанией, но по возможности с одного компьютера, чтобы оставить больше свободных мест! Первый сбор На первый Доквариум мы приглашаем вас в четверг 28 июля, в 16:00 по московскому времени. Ориентировочно мероприятие займёт 2 часа. Тема: «Инструменты технического писателя». Анастасия подготовила доклад «Создаём документацию с удовольствием в MadCap Flare», в котором она поделится своим многолетним опытом работы в MadCap Flare, а вы сможете задать ей любые вопросы. Кстати, недавно в нашем блоге была статья Анастасии на эту тему. Далее технический директор компании «ПроТекст» Валерий Ледовской расскажет о средствах нашей работы: «Инструменты компании ПроТекст при выполнении задач технического перевода и локализации на аутсорсинге». Затем нам хотелось бы послушать рассказы самих участников об использовании разных инструментов, кроме самого распространённого варианта — Microsoft Word. Хотя если вы используете его каким-то необычным образом, мы тоже с удовольствием узнаем и о вашей практике!
Профессия технический писатель: чем занимается и как проходит типичный рабочий день
| Оклад: 25000-30000 руб. | 5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей – TechWriter Days. |
| Газета.Ру в соцсетях | Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023! |
| TechWriter Days | найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. |
Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
Название клуба образовалось от первых букв английских слов Poets — поэты, Essayists — очеркисты и Novelists — романисты. Традиции праздника Во Всемирный день писателя вручаются награды и премии проявившим себя литературным деятелям. В библиотеках, национальных ПЕН-центрах и литературных музеях устраиваются книжные выставки и презентации новых художественных произведений, организуются творческие встречи с авторами. В школах уроки литературы посвящаются известным классикам. Интересные факты Русский ПЕН-центр возник в 1989 году. Его штаб-квартира находится в Москве. Президент РФ В. Путин объявил 2015-й год в России Годом литературы. Первым лауреатом Нобелевской премии по литературе стал в 1901 году французский поэт и эссеист Сюлли-Прюдом.
Вертикальный рост технического писателя Вертикальный рост технического писателя прост и понятен. В подразделении Nota. Docs четко выстроена градация между специалистами уровня Junior, Middle и Senior: Junior — новичок, обладающий базовыми компетенциями: грамотность, владение MS Office, системность и структурированность мышления, внимательность к деталям.
Но ему нужна помощь от более опытных коллег по ряду вопросов. Middle — это человек с опытом, который работает самостоятельно. Если ему поставили задачу, он не прибегает к помощи других коллег-техписов.
Это не означает, что он не имеет права задавать вопросы другим участникам проектной команды. Но значит то, что за ним не надо проверять. Он знает, как добыть информацию, к кому пойти по тому или иному вопросу и знает срок, к которому все должно быть сделано, а также в каком объеме и качестве.
Senior — это уже расширенные компетенции и нечто большее, чем все функциональные обязанности специалиста Middle. Это «большее» может быть с точки зрения, например, управленца — то есть человек, который ставит задачи нескольким мидлам. Или человек, который глубоко знает определенную предметную область или систему.
Поэтому специалист может вырасти до ведущего технического писателя, в подчинении которого находится несколько специалистов, затем — в руководителя подразделения технической документации. Кому подходит карьера технического писателя Главное качество, которое отличает технического писателя — это ответственность. Потому что мы работаем с формальным треком, который с крупным заказчиком проходит через его внутренний электронный документооборот, сопроводительные бумаги и письма.
Поэтому невозможно физически договориться о том, что мы сегодня не успели и сделаем завтра. Если срок сдачи документа — 30 сентября, то не позднее этого дня он должен быть любой ценой. Но при этом вариативность типа личности, которому подходит карьера технического писателя, велика.
Есть люди, которые целый день проводят в переговорах, обсуждении договоренностей и планов. А есть те, кто сидит и разбирается в функциональности продукта, выясняет, что за полгода сделали разработчики. Именно от специфики проекта зависит тот склад ума и характера человека, который под него подходит.
Предположим, в компании открыто несколько вакансий технических писателей на разные проекты. Давайте смоделируем несколько ситуаций: проектов и подходящих под них типажей кандидатов. Типаж 1 — «библиотечный бука» Есть проект А, на котором приходится писать сложные документы.
Например, пояснительную записку на 1000 страниц с техническими подробностями. Человек, который подходит под этот проект, может быть не очень коммуникабельным, но должен быть своеобразным «библиотечным букой»: зарыться в техническую информацию и сидеть с ней разбираться, выстраивая из этого стройный текст. Типаж 2 — «решала» Проект Б.
На проекте много согласующих, но несложная документация. Не требуется глубоко лезть в технические вещи. На этом проекте, чтобы согласовать небольшую стопку документов, нужно встретиться с заказчиками и с 5-6 людьми договориться, понять, что они хотят, найти к каждому подход.
Поэтому на этот проект нужен своеобразный «решала» — человек, который умеет договариваться, нравиться людям и находить компромиссы. Типаж 3 — «бодала» Проект В.
Открытие выставки «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева На выставке представлены иллюстрации Николая Кочергина «Богатыри» , Наума Цейтлина «Шесть Иванов — шесть капитанов» , Дмитрия Махашвили «Тысяча четыреста восемнадцать дней» , Льва Токмакова «Сказки у костра» и других художников. Выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева С приветственным словом выступила первый заместитель директора РГДБ Анжела Лебедева: Сегодня мы открываем выставку работ иллюстраторов замечательного писателя, человека героической судьбы Анатолия Васильевича Митяева. Я всех поздравляю с открытием: очень символично, что оно проходит накануне великого праздника Победы и в честь дня рождения писателя. Анжела Лебедева Художник-иллюстратор, доцент кафедры «Иллюстрация и эстамп» Института графики и искусства книги имени В. Фаворского Московского Политеха Ольга Монина поделилась воспоминаниями из детства об Анатолии Митяеве: Мои детские и юношеские воспоминания о Митяеве укладываются в слово «улыбка».
Он действительно улыбался везде, в том числе и на рабочем месте — в редакции журнала «Мурзилка». Для меня самый тёплый «Мурзилка» — это именно митяевский «Мурзилка».
Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию.
Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца.
Только так получится хорошая и качественная документация. Один в поле не воин Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе.
Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику. На поверку становись! Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики.
Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации. Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты.
Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы. Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД. Есть руководства пользователя с подробным описанием каждой кнопки интерфейса.
Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке.
Все новости
К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты о писателе, который считается и русским, и американским. Известный нижегородский писатель Валерий Шамшурин так сказал о нем. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования.
Один день из жизни технического писателя. Среда.
25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. Последние события в режиме онлайн: главные новости российского бизнеса и политики, международные события, криминальные происшествия, обзоры прессы, движения фондового рынка, лента спортивных новостей, автомобильные новости. День рождения Жириновского, второй сезон "Игры в кальмара" и первомай. 02:04. Служба безопасности День. Табло. Глобалисты провоцируют жёсткие санкции. Поздравляем всех технических писателей страны с профессиональным праздником и желаем нескучных рабочих будней, отличного настроения и благодарных пользователей!
: техническим писателем ✒
| Военная операция на Украине | Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно. |
| История профессии технического писателя: okwrite — LiveJournal | Сталин и писатели. |