Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov. Роль технического писателя Технический писатель переводит «от разработчика – клиенту». Новости дня читайте на Взгляде. Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля.
Работа технического писателя в IT-компании: цели, зоны роста, кому подходит
5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей «TechWriter Days». Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. «Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны.
Работа технического писателя в IT-компании: цели, зоны роста, кому подходит
День технического перевода. Степан ЖуринГазета «Лицейский вестник» и «Лицейское телевидение»15 октября 2019. 5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей – TechWriter Days. Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех». Станислав, вы описали самый отличный день технического писателя.
Презентация "Профессия Технический писатель" для студентов НИУ ВШЭ (27.10.2020)
Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись. Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами. Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах. Биоритмы и конвенции Режим рабочего дня, как и процессы, тоже не особо изменился. Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11. Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время.
В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы. Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN. Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день. У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть. Об этом нужно рассказать подробнее. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде.
Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах.
Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает.
Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira.
А с русским и литературой, наоборот. Поэтому какое-то время мечтала стать писателем. Бойтесь своих желаний, как говорится ". Последние записи:.
И, конечно же, не только сделает ваш «перевод на пользовательский» полезным, но и заставит его звучать нативно. Хорошее владение IT-терминологией, погружение в IT-тематику. Действительно, техписам нередко приходится добавлять к документации схемы, графики, красивые таблицы и другие графические элементы. У некоторых компаний обозначено требование к наличию технического образования. Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon. Наша команда трудится на благо одного департамента разработки. В департаменте 3 направления — у каждого свой техпис. Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач.
Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды. Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов. Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации. Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение.
Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе. Даже этот рассказ о себе мне сложно писать. Я отучился год на журфаке, а потом перешел в вышку на менеджмент.
В феврале в модельной библиотеке им.
Салтыкова-Щедрина технический день переносится с последней среды месяца на вторник 22 февраля. В этот день библиотека будет закрыта для посещений: в ней будет происходить обеспыливание книг и помещений, вестись другие санитарные работы.
Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23
В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября. Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN.
Какие знания и навыки нужны
- Текста больше, чем кода
- Зачем нужны техписатели?
- Поиск по сайту
- КАЗАНСКИЙ НАЦИОНАЛЬНЫЙ ИССЛЕДОВАТЕЛЬСКИЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ ИМ. А. Н. ТУПОЛЕВА - КАИ
Февральская встреча Сообщества технических писателей Санкт-Петербурга
Отображение сетевого контента Отображение сетевого контента 5 июля 2023 года - 120 лет со дня рождения писателя Владимира Григорьевича Сутеева 06. Один из зачинателей отечественной мультипликации. В 1924-м году Владимир поступил в Государственный Техникум Кинематографии, где обучался на художественном факультете. Интересно, что вместе с Сутеевым учился его двоюродный бат Дмитрий Боголепов , ставший в дальнейшем известным режиссером.
Представлено одно из первых произведений писателя «Васюткино озеро». Автор книги также приводит переписку Астафьева с игарчанами. Основная часть фотоматериалов взята из фондов писателя и Красноярского краевого краеведческого музея. Особое место в творчестве Виктора Астафьева занимала Великая Отечественная война. На фронт он пошел добровольцем, служил шофером, артиллеристом, разведчиком, связистом, пока в 1944 г. В раздел «Солдатские затеси» вошли произведения на военную тему, написанные автором по своим воспоминаниям: «Прокляты и убиты», «Где-то гремит война», «Пастух и пастушка».
Также можно ознакомиться с первой публикацией повести «Веселый солдат» в журнале «Новый мир» 1998 г. Город Чусовой — литературная родина Виктора Астафьева. Он жил здесь в 1945-1962 гг.
Так вот, я — технический писатель, и я постараюсь рассказать вам об этой интересной профессии на примере одного из своих рабочих дней.
Открываю глаза, на часах 6. Вот и наступила рабочая неделя. Одеваюсь, выпиваю кружку горячего кофе. Спасибо этому волшебному напитку, что избавляет нас от полудремы, выветривая остатки приятного сна.
Иду на работу. Захожу в офис. Приветливо здороваюсь с секретарем на ресепшене и также встречаю своих коллег. Включаю компьютер, запускаю все необходимые программы.
С этого момента вся жизнь будто закипает… Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Бумажный документооборот здесь — давно забытое прошлое, и это нужно понимать с первых дней. Ровно в 9. Вы спросите, что это такое?
Летучка — это короткое собрание всех писателей с целью осветить текущую деятельность каждого что сделали в прошлый день, что делаем сегодня, что планируем сделать на неделе. Зачем это нужно? Над отдельным проектом обычно работает не один человек, а несколько. Поэтому нужно, чтобы каждый был в курсе дел и смог вовремя получить необходимую информацию.
С 1984 года журнал поменял своё название на «Хроника наших дней» изменились заставка и музыка журнала. В ряде городов СССР, например, в Минске, были созданы специальные кинотеатры «Новости дня» для демонстрации выпусков одноименного киножурнала.
Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
Я обычно говорю, что это одна из самых удачных профессий для выпускников технических вузов. Потому что техписатели знают всё о компании и её продуктах, пересекаются по задачам буквально со всеми участниками разработки и из этого могут выбрать для себя лучшее направление развития. Знаю людей, кто с такими мыслями в техписательстве оказался, но понял, что ни на что теперь не променяет свою профессию. Хотя есть и те, кто попробовали и перешли в разработку, аналитику, управление проектами. И я, кстати, только рада, что ребята дальше несут культуру документации — легко писать качественную доку, когда вас целый отдел, все друг друга вычитывают и часами могут обсуждать нюансы формулировок. А вот когда документация — вспомогательная деятельность, начинаются сложности. Поэтому я радуюсь каждый раз, когда люди приходят обсуждать доку, подходы к ней, инструменты — это же не только о техписателях, но о гигиене ИТ в целом.
Какую документацию готовит техпис? Если коротко — почти любую техническую документацию. На самом деле, объём и типы документации от компании к компании могут сильно отличаться. Мануалы, инструкции, справочные материалы, FAQ по продуктам компании для конечных пользователей — это прямая обязанность. Спецификации, справочная информация для разработчиков, внутренняя документация для взаимодействия внутри команд и между ними, корпоративные базы знаний — не прямая обязанность, но часто перепадает именно на долю технического писателя или он как минимум всё это проверяет, упорядочивает и доводит до ума. UX-тексты подсказки, пункты меню, и т.
Технические переводы с русского на иностранный и обратно — чаще всего именно задача техписа, но здесь есть нюанс с владением языками, поэтому нередко ему помогают переводчики особенно в мультиязычных компаниях. Теодора Малевинская Держатель профессии «технический писатель» в Тинькофф О себе: Строю техписательские процессы для разработчиков, собираю редакции, развиваю профессиональное сообщество в компании и вне. Я очень люблю обращаться к статистике — это аргументы, которые я часто привожу: Исследование 1 В 2016 StackOverflow провёл исследование среди разработчиков о том, с какими проблемами они сталкиваются в работе. Исследователи делают вывод: «Это показывает как важно для компаний иметь хорошо написанную документацию». Исследование 3 Nintex проводили исследование о самых неэффективных процессах в ИТ-компаниях. Я сама наблюдаю, что часто такая проблема бывает из-за того, что какие-то ошибки или процессы не описаны в документации.
Источник В целом мы видим, что разработчики читают документацию, но большинство сталкивались с проблемой: её не было или она была неполной. Плохая документация — это неоправданно дорого для компаний. Особенно, если она к продукту, которым пользуются многие. За последние четыре года не раз видела случаи, когда технический писатель переписывал инструкцию и экономил часы и дни разработчиков. Например, техписатель понятно переписал онбординг, который прошли 500 человек. Это заняло у них 3 дня, а не 5.
Оставшиеся 8000 часов можно потратить на разработку фич или ещё что-то полезное для компании, ведь теперь им не надо писать вопросы в чат поддержки. Что должен знать и уметь технический писатель?
Однажды он стрелялся с близким другом Кюхельбекером, потому что задел его обидной шуткой. В тот раз все обошлось, поскольку секунданты зарядили пистолеты клюквой вместо пуль. У Льва Толстого был очень неразборчивый подчерк. Чтобы издатели смогли напечатать его произведения, жена и дочь вынуждены были переписывать рукописи.
Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей. UnaDesk Специализированное программное обеспечение для автоматизированного создания сценариев работы пользователей в ИТ-системах и, на базе этих сценариев, создания учебных материалов, симуляций и документации для пользователей различных ИТ-систем, что позволяет сопровождать пользователя по всем шагам, необходимым для выполнения бизнес-процесса в ИТ-системах Подробнее Российский разработчик системы для быстрого освоения корпоративного ПО HintEd Платформа интерактивного обучения работе в корпоративном ПО. Обучающий слой поверх любого ПО: браузерного, или в виде отдельных Windows-приложений. Экзамус Экзамус разработал технологию, которая анализирует поведение пользователей любых онлайн-сервисов с помощью распознавания лиц и обнаружения эмоций. Для работы с продуктом достаточно наличия у пользователя мобильного устройства или компьютера с веб-камерой.
А с русским и литературой, наоборот. Поэтому какое-то время мечтала стать писателем. Бойтесь своих желаний, как говорится ". Последние записи:.
Февральская встреча Сообщества технических писателей Санкт-Петербурга
Сталин и писатели. Станислав, вы описали самый отличный день технического писателя. Кастинг, вакансия для ДРУГОЕ: (Удаленка) Требуется технический писатель.
Всемирный день писателя – 3 марта!
Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. технические характеристики mitsubishi galant 25 i vr-4 type-v 4wd. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов.
День технического специалиста на PulpFor 2023
Приглашаем на очередную встречу технических писателей. Основная тема — Документация и справка мобильных приложений. Кроме того, в ходе Lean cafe техрайтеры нашего города расскажут о своих достижениях, поделятся секретами и обменяются опытом. Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. Приглашаем вас встретиться в SEMrush и поздравить друг друга 10 февраля, в пятницу.
Каждый день для вас: интересные книги, свежая и актуальная информация, познавательные мероприятия. Бесплатно: курсы компьютерной грамотности и основы создания видеоигр, помощь юриста. Технический день в модельной библиотеке им.
Технический писатель переводит понятные и прописные истины программиста на удобный для пользователя язык. Для этого он идет к разработчику и задает вопросы о том, как работает система.
Для оплаты услуг субподрядчика или оплаты услуг компании нужны сопутствующие документы. Технический писатель вместе с финансовым отделом участвует в разработке этих документов для заказчика и их приемке от субподрядчика. С ними технический писатель обсуждает логику создания продукта, которую те придумали для разработчиков. Иногда совместно с аналитиками технический писатель может создавать документацию для команды разработки. Взаимодействие с дизайнерами нужно для того, чтобы задокументировать те или иные решения по дизайну. Руководители проектов. С РП технический писатель взаимодействует для координации и контроля над соблюдением всех необходимых формальностей со стороны участников проекта. Обеспечивает консистентность формальной части проекта. Цели работы технического писателя Работа в сфере заказной разработки — это командный вид спорта, поэтому цель работы технического писателя — это успех всей команды, всего проекта.
Антицель — написать красивый документ по ГОСТу, по которому невозможно провести испытания демонстрацию продукта заказчику , либо который не коррелируется с разработанной функциональностью продукта. Поэтому технический писатель разрабатывает документацию для целей, которые должны совпадать с целями компании. Если он пишет отчетную документацию по конкретному проекту, то он должен тесно взаимодействовать с проектной командой и осознавать, что разработанная функциональность будет приниматься заказчиком именно на основе написанной им отчетной документации. А ошибки в отчетной документации приводят к провалу испытаний или вовсе к отказу в приемке работ. Для технического писателя важно не зацикливаться на самом тексте, а смотреть в суть. Прийти к разработчику и спросить: «Все ли я правильно понял и написал? Еще один важный момент — технический писатель должен не только предоставить заказчику комплект отчетной документации, но и согласовать ее с ним. Если клиенту что-то не нравится — выяснить, что именно, и понять, как это исправить. Куда расти техническому писателю Представим ситуацию, что человек приходит на позицию технического писателя, перерастает грейд Junior и в какой-то момент начинает думать: «А куда дальше развиваться?
Буду ли я до конца карьеры писать технические документы, такие как руководство пользователя? У технического писателя есть конкретные зоны роста — как горизонтального, так и вертикального. Поговорим о горизонтальном росте подробнее. Хороший технический писатель должен знать, какие шаги нужно пройти для успешной сдачи проекта. Это шаги, которые находятся не только в его компетенции, но и которые должны пройти другие участники команды: дизайнеры — нарисовать макеты, разработчики — написать код, аналитики — описать бизнес-процессы. И контроль выполнения работ другими участниками команды тоже может быть в числе обязанностей техписа. Также техпис должен уметь оценивать затраты на разработку той или иной документации: Сначала сформулировать требования к другим участникам команды — в каком виде и в какие сроки ему должны предоставить исходные данные для формирования комплекта отчетной документации. С учетом качества и количества исходных данных прикинуть свои трудозатраты на формирование отчетной документации. Уложить это все на план-график исполнения контракта, понять, сколько нужно людей, какой трек согласования документации, и как вообще при этом выжить.
То есть это процессное и ресурсное управление, которым он должен владеть. И это схожие процессы с теми, которые есть у руководителя проекта. Что из этого следует: техпис может быть правой или левой рукой руководителя проекта и, соответственно, в этом направлении развиваться.
Особенно с учетом дочки — мастера спорта международного класса по художественной пятнистике и многодырью. Видели бы вы ее белые футболки! Хотя, честно говоря, и я не видела: слишком уж быстро дочь ставит первое пятно. А еще мы купили ей туфли 31 августа, а 14 сентября она из них выросла.
Парам-парам-пам — пиу! Где-то в этом промежутке. Весной мы всей семьей ездили в Нижний Новгород повидаться с родственниками. Потом сын летал на Байкал с группой из скаутского лагеря. Летом наши друзья возили его и дочь из Питера в Териберку с заездом по пути вообще везде. Прикиньте, дочка купалась в Северном Ледовитом океане! А сын не стал.
Пока они катались, муж таскал меня — в формате «загрузил в машину и повез, возражения не принимаются» — в Выборг, Великий Новгород и Сортавалу. В последнюю мы поехали встречать детей сюрпризом, заодно погуляли по горе Паасо и древнему саамскому лабиринту. Решили в итоге и Новый год справлять в Карелии, забронировали жилье на турбазе под Петрозаводском c 30 декабря по 2 января. Ветеринария: протяжно воет на два голоса с кошельком. Про кота, который умер, я уже упоминала. А когда кошка перестала прыгать, мы обследовали ее со всех сторон, ничего толком не нашли. Только в августе, когда она окончательно слегла, ей поставили диагноз «полирадикулоневрит», и тот под вопросом.
Выяснилось, что эта хрень как приходит, так и уходит сама. Или не уходит. А так, черт его знает. И тут бывали эксцессы. Как-то кошка отказалась есть и писать — немедленно вылетела с ней к вету, а оказалось, что этой скотине надоели паучи и она хотела сушки. Как только в клинике насыпали сухого корма, начала лопать за обе щеки. Платили вместе с мужем.
Мужу в этом году подарю переезд в Алматы, хе-хе-хе. Когда сын будет жить один, планирую переводить деньги по мере необходимости: на карманные, на еду, на квартплату, на дополнительные расходы. Одежду мы заказываем на «Вайлдберриз», это оплачивается с моей карты. Репетиторов и прочее я тоже оплачиваю сама. В остальных категориях расходов все по-прежнему, как в предыдущем дневнике. В плане ведения бюджета тоже ничего не изменилось. День из жизни 03:00.
Просыпаюсь в снятой посуточно квартире. Где-то наверху рыдает ребенок, судя по выговору, лет полутора-двух. И родители бедолаги. Засыпаю, поболтав в «Телеге» с сыном. Мы оба очень болезненно переживаем разлуку. Но наши психотерапевты убеждают, что стоит попробовать пожить раздельно, к тому же это всегда можно откатить назад. Плюс я постоянно на связи и есть те, кто может помочь сыну в Питере.
Соответствующие доверенности оформлены. Снова просыпаюсь. К 11 надо идти подписывать договор аренды: нашла съемную квартиру семье. Всю неделю здесь занимаюсь делами, что, в общем, ожидаемо.