Технические писатели. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. С целью напоминания о роли писательства в мире был учреждён Всемирный День писателя, который отмечается ежегодно 3 марта.
: техническим писателем ✒
Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы. Выходили и специальные выпуски, посвященные очередному съезду КПСС, выборам, праздничным датам, торжественным похоронам видных государственных и политических деятелей.
Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию.
Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца.
Только так получится хорошая и качественная документация. Один в поле не воин Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику.
This can help expand the professional network, discover new ideas and solutions, and establish potential partnerships. Enhancing Company Visibility.
Company participation as a conference partner can increase visibility and the dissemination of information about its products and services. It can also attract the attention of potential customers and partners. Receiving Feedback. Companies can utilize conference opportunities to receive feedback from technical writers and other participants regarding the quality of their documentation. This enables improvements in product documentation and meets customer needs. Fostering a Culture of Learning and Innovation. Participation in the conference contributes to the creation of a culture of learning and innovation within the company. Employees can return from the conference with new ideas and motivation to enhance processes and products. Competitive Advantage.
Companies that invest in the training and development of their technical writers can gain a competitive advantage by creating more high-quality and informative documentation for their products.
Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Процесс работы технического писателя.
Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними.
Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов. Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану.
Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель. Профессии технического писателя в российских вузах не учат. Есть курсы, где можно научиться писать технические тексты, но их немного. Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других. Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений.
В отличие от копирайтинга, здесь меньше творчества и больше регламентов. Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли. Технический писатель должен сочетать в себе свойства технаря и гуманитария. Интерес к технике и программированию, усидчивость и внимательность должны в нём сочетаться с желанием осваивать новое и делиться своими знаниями. Очень важно знать предметную область, в которой ведется работа. Например, если вакансия открыта в ИТ-компании, потребуется знать языки программирования и разбираться в процессах разработки софта.
Лента новостей
Самые свежие новости России и мира, новости политики, шоу-бизнеса. онлайн на сайте девушка при исполнении, а в свободное время - поэт. Роль технического писателя Технический писатель переводит «от разработчика – клиенту». Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера.
НОВОСТИ ДНЯ
Мы ищем технического писателя в команду Indeed Access Manager. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. 120 лет со дня рождения писателя Владимира Григорьевича Сутеева/. Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. 120 лет со дня рождения писателя Владимира Григорьевича Сутеева/.
Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
Опыт работы в аналогичной должности (или инженером – электроником) от одного года. Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна. В этот четверг (25.11) в 18-00 пройдет презентация профессии технический писатель и команды технических писателей Orion Innovation. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. Самые свежие новости России и мира, новости политики, шоу-бизнеса.
Один день технического писателя
| День технического специалиста на PulpFor 2023 | за профессионализм, признание професии и чистоту русского языка (и в технических документах тоже)! |
| День писателя | Должность: технический писатель, хотя в последнее время скорее knowledge manager. |
| Обязанности технического писателя | Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно. |
#Кем стать: Техническим писателем
Жителей Молдавии призвали праздновать День Европы вместо Дня Победы. Самые свежие новости России и мира, новости политики, шоу-бизнеса. Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. 120 лет со дня рождения писателя Владимира Григорьевича Сутеева/. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева.
5 июля 2023 года - 120 лет со дня рождения писателя Владимира Григорьевича Сутеева
Открытие выставки «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева На выставке представлены иллюстрации Николая Кочергина «Богатыри» , Наума Цейтлина «Шесть Иванов — шесть капитанов» , Дмитрия Махашвили «Тысяча четыреста восемнадцать дней» , Льва Токмакова «Сказки у костра» и других художников. Выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева С приветственным словом выступила первый заместитель директора РГДБ Анжела Лебедева: Сегодня мы открываем выставку работ иллюстраторов замечательного писателя, человека героической судьбы Анатолия Васильевича Митяева. Я всех поздравляю с открытием: очень символично, что оно проходит накануне великого праздника Победы и в честь дня рождения писателя. Анжела Лебедева Художник-иллюстратор, доцент кафедры «Иллюстрация и эстамп» Института графики и искусства книги имени В. Фаворского Московского Политеха Ольга Монина поделилась воспоминаниями из детства об Анатолии Митяеве: Мои детские и юношеские воспоминания о Митяеве укладываются в слово «улыбка». Он действительно улыбался везде, в том числе и на рабочем месте — в редакции журнала «Мурзилка». Для меня самый тёплый «Мурзилка» — это именно митяевский «Мурзилка».
А с русским и литературой, наоборот. Поэтому какое-то время мечтала стать писателем.
Бойтесь своих желаний, как говорится ". Последние записи:.
Прелесть этой работы в том, что здесь можно применять творческий подход, оставаясь в чётко очерченных рамках и решая конкретную задачу.
А именно на стыке этих двух методов и происходит настоящая магия. Как говорила матерь всех переводчиков Нора Галь, «переводить надо не слово, не букву, а дух и смысл». И я верю в то, что этот принцип должен лежать в основе любой работы с текстом, особенно в работе технического писателя.
С чем бы вы ни работали, думать о смысле — лучшее, что вы можете сделать для себя, для читателя и для заказчика. Это избавит вас от многих проблем и поможет решить большинство возникающих в работе вопросов. И, конечно же, не только сделает ваш «перевод на пользовательский» полезным, но и заставит его звучать нативно.
Хорошее владение IT-терминологией, погружение в IT-тематику. Действительно, техписам нередко приходится добавлять к документации схемы, графики, красивые таблицы и другие графические элементы. У некоторых компаний обозначено требование к наличию технического образования.
Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon. Наша команда трудится на благо одного департамента разработки.
В департаменте 3 направления — у каждого свой техпис. Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач.
Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды. Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов. Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации.
Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают.
Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами.
Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям.
Дети внимательно слушали рассказ библиотекаря о детстве писателя, знакомились со стихами - удивлялками, размышлялками и считалками, узнали, что у Бабы Яги есть своя Азбука, послушали весёлые стихотворные правила поведения.
Познакомились с книгой и посмотрели мультфильм о приключениях необыкновенной собачки Сони, которая очень любит думать. Юные участники мероприятия с удовольствием отгадывали загадки, внимательно слушали стихи и песни в исполнении самого Андрея Усачёва и сами рассказывали его стихи. После мероприятия ребята с интересом рассматривали книги, принесённые библиотекарем.
День писателя
| Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева | Опыт работы в качестве технического писателя в области разработки и внедрения информационных систем от 3х лет. |
| История профессии технического писателя: okwrite — LiveJournal | Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. |
| Конференция TechWriter Days 05.04.2024 - 06.04.2024 | Поздравляем всех технических писателей страны с профессиональным праздником и желаем нескучных рабочих будней, отличного настроения и благодарных пользователей! |
| День технического писателя: shamanidze — LiveJournal | З марта отмечается Всемирный день писателя03.03.2022 18:33 — ННТВ (видео). |