В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией.
Подпишитесь на рассылку
- «День с писателем». |
- Технический писатель - АО «Энергомера»
- Выставка к 100-летию писателя Виктора Астафьева
- Технический писатель - АО «Энергомера»
- Газета.Ру в соцсетях
Профессия технический писатель: чем занимается и как проходит типичный рабочий день
Затеси очень разные по своему содержанию и объему, порой это всего несколько абзацев. Сам автор дает такое определение: «Затесь — сама по себе вещь древняя и всем ведомая — это стёс, сделанный на дереве топором или другим каким острым предметом. Делали его первопроходцы и таежники для того, чтобы белеющая на стволе дерева мета была видна издалека, и ходили по тайге от меты к мете, часто здесь получалась тропа, затем и дорога, и где-то в конце ее возникало зимовье, заимка, затем село и город». На выставке представлено первое издание «Затесей» 1972 года.
Всего писатель создал свыше двухсот художественных произведений, которые издавались более ста раз почти в тридцати странах. Экспозиция состоит из пяти разделов, каждый из которых носит название географических мест, где жил и работал писатель. Они были не только частью биографии Астафьева, но и неизменно присутствовали в его произведениях.
Раздел «Игарские затеси» рассказывает о детских годах жизни драматурга и его трудах, в которых описывается заполярный город Игарка. Интерес представляет уникальное издание «Игарские затеси» Валентины Гапеенко.
Обратно еду на такси, не хочу таскаться в обнимку с подушкой и одеялом. Сокрушаюсь, что мобила фотографирует так себе, но что делать, за неимением гербовой пишем на клозетной 15:30. Закидываю все в квартиру и обнаруживаю, что чайника в ней тоже нет. Что ж, опять иду в хозяйственный. Чайник по дороге пытался упрыгать: порвалась коробка. Но вроде живой.
Бобик сдох. Кидаю на кровать привезенный с собой лоскутный плед, валяюсь. А нет, уже не валяюсь. За неимением рулетки меряю кровать собой и заказываю в ближайший на этот раз пункт «Вайлдберриз» новое постельное белье. И привычное средство для стирки без запаха. И еще одну подушку, потому что имеющаяся какая-то не очень. Кроме пледа, чтобы на новом месте было уютнее, я взяла с собой фигурку, которую сын подарил на день рождения, записку с рисунком от дочки и кольцо, которое муж распечатал на 3D-принтере. Располагаюсь на кухне с виноградом и ноутбуком.
Читаю «Реддит», болтаю в «Телеге» и «Дискорде». Обнаруживаю, что окна квартиры выходят на запад. Неожиданно, но приятно 18:30. Пишет коллега — они в соседнем доме, предлагает завтра погулять. Всегда за! Свежекупленный чайник пахнет пластиком, нормальный куплю потом, а пока попытаюсь привести в чувство имеющийся. Добавим к этому кризис шоколадных сырков и мандаринов, случайно моргнем и получим доставку «Рядом» — это типа российского «Самоката». Конина, впрочем, очень вкусная, я в первый же день попробовала.
Ужасно болит голова. Точно помню, что брала с собой таблетки, но никак не могу их найти. Злюсь и выкидываю все из рюкзака. Сколько же го… ловокружительно разных вещей там валяется. Таблетки нашлись в кармане, о существовании которого я вообще не подозревала. О сколько нам открытий чудных готовят просвещенья дух. Сейчас бы полежать с котиком: у меня острый недокотин — но котики в Питере. И муж в Питере.
И дети в Питере. И друзья в Питере. Очень не хватает семьи, друзей и кошек. Ну и в целом ощущения Питера кругом, я его очень люблю. Закажу-ка еще кухонных и банных полотенец и займусь вонючим чайником, а то с такими мыслями далеко зайти можно. Спойлер: избавиться от запаха так и не удалось, купила новый чайник. Наконец-то происходит ничего. Давно пора.
Читаю «Реддит», ем мандарины и сырок — сегодня день сырка, треплюсь в «Телеграме». На кухне, кстати, уютно, пожалуй, назначу ее пока рабочим местом. В один из чатов скидывают ссылку на курс по аналитике, над которым я думала, — на него скидка. Но увы, на отдельные модули скидки нет, а весь курс я проходить не хочу. Особенно не хочу делать конечный проект или как там его.
Действительно, техписам нередко приходится добавлять к документации схемы, графики, красивые таблицы и другие графические элементы. У некоторых компаний обозначено требование к наличию технического образования.
Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon. Наша команда трудится на благо одного департамента разработки. В департаменте 3 направления — у каждого свой техпис. Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач. Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды.
Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов. Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации. Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование.
Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе.
Даже этот рассказ о себе мне сложно писать. Я отучился год на журфаке, а потом перешел в вышку на менеджмент. Оба образования мне пригодились, потому что со временем я стал лидом. В работе техписа мне нравится упорядочивание — из страшного сумбурного текста делать стройный и понятный.
Так, Музей славянской письменности «Слово» приглашает 3 марта москвичей и гостей города на экскуссию «В поисках вдохновения». Она начнется в 16:30 и пройдет в историческом музейном зале. Ее участникам покажут, как выглядели первые книги в Древней Руси — Новгородский кодекс X век на липовых дощечках и Остромирово Евангелие XI век на пергаменте. После этого экскурсовод расскажет о самых ранних жанрах древнерусской литературы — торжественной речи и поучении, познакомит с уникальными произведениями XI века «Слово о законе и благодати» и «Поучение Владимира Мономаха».
Затем гостям представят самую раннюю сохранившуюся русскую летопись — Лаврентьевскую, датированную 1377 годом. После познавательного путешествия в прошлое посетители перейдут в библиотечный зал. Здесь пройдет практическое занятие. Им предложат попробовать написать поэтические строки. Покажут, как использовать разные стихотворные размеры и рифмы, применять игру слов. Часть беседы посвятят феномену авторского вдохновения и тому, как оно влияет на литературный труд и его результат. Для участия необходимо купить билет на экскурсию, а также отдельно приобрести билет на постоянную экспозицию музея «Слово». В этот же день в 19:00 в музее «Слово» состоится еще одна писательская экскурсия.
На ней речь пойдет о создателях древних книг — монахах-переписчиках. Они не только сохраняли и тиражировали духовные и летописные знания, но и сыграли важную роль в появлении авторских сочинений. Помимо этого, экскурсанты узнают о том, какие сообщения писали друг другу люди на берестяных грамотах. Затем они познакомятся с первыми произведениями русских путешественников, которые назывались хождениями. А еще гостям покажут уникальный памятник русской литературы XVII века — «Житие протопопа Аввакума, им самим написанное».
Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
Историю празднования Дня писателя узнают те, кто придет в библиотеку №107 (Перовское шоссе, д. 16/2). 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023! День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. Киножурнал "Новости дня" выходил с 1944 по 1983 годы.
366. День технической книги
Из отрицательных сторон деятельности нужно сказать о высокой ответственности, большую ограниченность в написании текстов, множество требований, которые надо исполнять. Технические писатели смогут устроиться на работу в организацию, которая разрабатывает программные продукты, технику бытового характера, аппаратуру, предназначенную для медицины, научного мира. Личные способности и профессиональные качества Важнейшими личными способностями технического писателя являются технические и гуманитарные умственные способности, необходимо сочетать их в работе. Также важны спокойствие и внимание, заинтересованность в программировании, стремление обучаться и делиться с другими людьми своими открытиями. К важнейшим профессиональным навыкам специалиста относятся умение четко и ясно излагать мысли в собственном тексте, знание технического английского языка, владение базовыми умениями программирования, графическими программами.
Карьера Карьерного роста технический писатель может достигнуть, перейдя на работу в более крупную компанию, после того, как повысит свой профессионализм и наберется опыт, можно уйти в другую отрасль труда, стать техническим директором.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах.
Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Процесс работы технического писателя.
Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик.
Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов.
Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду.
Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель. Профессии технического писателя в российских вузах не учат. Есть курсы, где можно научиться писать технические тексты, но их немного. Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других. Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений.
В отличие от копирайтинга, здесь меньше творчества и больше регламентов. Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли.
По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах.
Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария.
Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков.
Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально.
Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП.
Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент.
По итогам 2018 г. Уверенное владение офисным пакетом Microsoft Office работа со стилями, многоуровневыми списками, перекрестными ссылками и т.
366. День технической книги
Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно. 21 апреля в ГУНБ в отделе технической литературы (3 этаж, каб. 301) пройдет День технической книги. Главной целью для технического писателя является объяснить пользователю, как обращаться с приборами или компьютерными программами доступным и понятным языком. Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий. Роль технического писателя Технический писатель переводит «от разработчика – клиенту».
Обязанности технического писателя
Я технический писатель, хотя в последнее время скорее knowledge manager. 3 марта отмечается Всемирный день писателя. Этот праздник был учрежден в 1986 году по решению конгресса Международного ПЕН-клуба, который был основан в Лондоне в 1921 году. Главной целью для технического писателя является объяснить пользователю, как обращаться с приборами или компьютерными программами доступным и понятным языком. Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля. В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником.