«Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Кастинг, вакансия для ДРУГОЕ: (Удаленка) Требуется технический писатель. О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту.
: техническим писателем ✒
Согласитесь, что даже текст, написанный с орфографическими и стилистическими ошибками, может быть понятным и успешно выполнять свою функцию — доносить до читателя мысль автора. А ошибки — это дело поправимое, коррекцию и правку текста при необходимости может выполнить редактор или тот же технический писатель. Главное — не допускать ошибок фактических. Каждый должен заниматься своим делом. Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон.
Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей. Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы.
Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями». Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил.
В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются. Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки.
Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления. Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь». Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку.
Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями.
Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано.
Платформа управления целями и вознаграждениями Leenda Платформа для совместной разработки образовательного контента Knomary Production Разработка обучающих курсов любого формата под индивидуальные требования Функции прокторинга подключаются к платформам тестирования, что позволяет проводить контролируемые дистанционные экзамены как в ручном, с участием прокторов, так и в автоматическом режиме. Контролируемые экзамены снижают риски, связанные с репутацией и организационными расходами, а также повышают качество компетенции сотрудников и студентов. ProctorEdu Компания помогает образовательным учреждениям, предприятиям и бизнесу проводить достоверные онлайн-тестирования, снижать организационные расходы и достигать KPI, предоставляя передовую систему с полностью автоматизированным, асинхронным и синхронным прокторингом. Программное обеспечение для онлайн-наблюдения, протоколирования и оценивания поведения пользователей при прохождении значимых онлайн-мероприятий экзаменов, тестирований Подробнее Ведущий разработчик технологий для корпоративного онлайн-обучения в секторе крупного и среднего бизнеса. Решения одобрены Минкомсвязи России и входят в единый реестр отечественного программного обеспечения.
В ИскраУралТел открыта вакансия Технического писателя В ИскраУралТел открыта вакансия Технического писателя Чем предстоит заниматься: - Коммуникации с заказчиком по защите и утверждению документации; - Разработка и утверждение документации по ГОСТ 19, 34; - Подготовка и согласование технических заданий; - Оформление требований.
Теперь о вашем опыте и навыках, которые мы считаем ключевыми для вашей успешной работы.
Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. Дети внимательно слушали рассказ библиотекаря о детстве писателя, знакомились со стихами - удивлялками, размышлялками и считалками, узнали, что у Бабы Яги есть своя Азбука, послушали весёлые стихотворные правила поведения. Познакомились с книгой и посмотрели мультфильм о приключениях необыкновенной собачки Сони, которая очень любит думать. Юные участники мероприятия с удовольствием отгадывали загадки, внимательно слушали стихи и песни в исполнении самого Андрея Усачёва и сами рассказывали его стихи.
Военная операция на Украине
День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. Жителей Молдавии призвали праздновать День Европы вместо Дня Победы. Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov. Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. На сайте в рубрике «Наука и техника» всегда свежие новости за день и неделю.
Военная операция на Украине
Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки.
Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей.
В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке.
ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении.
Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге. Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т.
В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему. Пока сделать перерыв и пойти выпить кофе.
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.
Поэтому какое-то время мечтала стать писателем. Бойтесь своих желаний, как говорится ". Последние записи:.
НОВОСТИ ДНЯ
Текста больше, чем кода — Кто за сутки до отправки заказчику во всей инструкции заменил manual на manul?! Давайте окинем взглядом весь процесс разработки программного обеспечения. Его главный результат — это, конечно, программный код. А его главными действующими лицами всегда были и будут программисты, что бы там ни говорили другие его участники. Но сам этот процесс попутно порождает большое количество текстовых артефактов. Тут и функциональные требования заказчика, и техническое задание, и многочисленные протоколы совещаний, и переписки в чатах, и комментарии к запросам в системе планирования задач, и, наконец, описание реализации. А ведь есть ещё многочисленные комментарии в коде, которые тоже содержат много нужной информации. В общем, текстов хватает. Так зачем же тогда в самом конце разработки нужен ещё и технический писатель?
Почему всех этих документов недостаточно для того, чтобы дать ответы на основные вопросы заказчика и пользователя: как работает система и как её настроить? Будем разбираться. Разработчики должны писать код, а не текст «Условие, что поле PART должно быть не пустым, обеспечивается целостностью процесса, заполняющего это поле, и не обеспечивается отдельным ограничением Oracle типа NOT NULL для обеспечения максимального быстродействия при изменении данных таблицы». Из внутренней документации проекта Бывает так, что программисты прекрасно разбираются в программе, досконально понимают все тонкости работы системы, но не могут красиво изложить всё это в текстовом виде. Лично я убеждён, что в этом нет ничего плохого. Согласитесь, что даже текст, написанный с орфографическими и стилистическими ошибками, может быть понятным и успешно выполнять свою функцию — доносить до читателя мысль автора. А ошибки — это дело поправимое, коррекцию и правку текста при необходимости может выполнить редактор или тот же технический писатель. Главное — не допускать ошибок фактических.
Каждый должен заниматься своим делом. Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон. Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей. Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы. Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями».
Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей.
Есть люди, которые целый день проводят в переговорах, обсуждении договоренностей и планов. А есть те, кто сидит и разбирается в функциональности продукта, выясняет, что за полгода сделали разработчики.
Именно от специфики проекта зависит тот склад ума и характера человека, который под него подходит. Предположим, в компании открыто несколько вакансий технических писателей на разные проекты. Давайте смоделируем несколько ситуаций: проектов и подходящих под них типажей кандидатов.
Типаж 1 — «библиотечный бука» Есть проект А, на котором приходится писать сложные документы. Например, пояснительную записку на 1000 страниц с техническими подробностями. Человек, который подходит под этот проект, может быть не очень коммуникабельным, но должен быть своеобразным «библиотечным букой»: зарыться в техническую информацию и сидеть с ней разбираться, выстраивая из этого стройный текст.
Типаж 2 — «решала» Проект Б. На проекте много согласующих, но несложная документация. Не требуется глубоко лезть в технические вещи.
На этом проекте, чтобы согласовать небольшую стопку документов, нужно встретиться с заказчиками и с 5-6 людьми договориться, понять, что они хотят, найти к каждому подход. Поэтому на этот проект нужен своеобразный «решала» — человек, который умеет договариваться, нравиться людям и находить компромиссы. Типаж 3 — «бодала» Проект В.
На этом проекте непростое согласование документов, потому что со стороны заказчика есть люди, у которых свое представление о прекрасном. Нет широкого поля для коммуникаций, нет глобальных технических сложностей, но тут, находясь в одной связке с заказчиком, надо уметь отстаивать свои интересы. Человек, работающий на этом проекте, должен уметь работать в одной команде с заказчиком, но при этом «бодаться» — защищать свое мнение.
Выводы Технический писатель в IT — это полноценный член проектной команды. Он взаимодействует со всеми участниками и напрямую отвечает за успех проекта. У технического писателя есть конкретные зоны роста, помимо создания технической документации — это менеджмент, аналитика и юриспруденция.
Технический писатель может расти как горизонтально, так и горизонтально-вертикально, так и вертикально. Не нужно сильно привязываться к софт-скилам. Они могут сильно отличаться в зависимости от типа проекта, на который ищут техписа.
Если вы библиотечный бука и не любите общаться — вы найдете работу. Если вы легкий на подъем, сильный в коммуникациях человек, но устаете от рутинной работы — вы тоже найдете работу. Хард-скилы также могут сильно отличаться и зависят от проекта.
Бывает, что нужен продвинутый техпис-аналитик, под конкретный проект с конкретным стеком технологий. И хард-скилы — это то, что легче прокачать, в отличие от софтов. Прямо сейчас у нас открыт набор технических писателей в нашу команду!
Если у вас уже есть опыт работы, или вы только хотите попробовать для себя эту специальность, присылайте резюме на почту [email protected] или в Telegram kSamohina. А если у вас есть вопросы о работе технического писателя в IT-компании, задавайте их в комментариях — мы с удовольствием на них ответим.
Вообще, отношения с ней были слегка натянутыми. А с русским и литературой, наоборот. Поэтому какое-то время мечтала стать писателем. Бойтесь своих желаний, как говорится ".
В компании Bercut работаю более 5 лет, очень люблю свою профессию. До прихода в Bercut работал преподавателем, техническим писателем и ведущим бизнес-аналитиком. Процессы и коммуникации в новой дистанционной реальности Как и большинство наших коллег в IT-сфере, сейчас мы работаем из дома. Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись. Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами.
Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах. Биоритмы и конвенции Режим рабочего дня, как и процессы, тоже не особо изменился. Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11. Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время. В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы. Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN. Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день.
У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть. Об этом нужно рассказать подробнее. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием.
Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает.
Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23
В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. Новости дня читайте на Взгляде. Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Мы ищем технического писателя в команду Indeed Access Manager.
Профессия технический писатель: чем занимается и как проходит типичный рабочий день
онлайн на сайте 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. Самые свежие новости России и мира, новости политики, шоу-бизнеса. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси.
Зачем нужны техписатели?
- День рождения инженера и писателя-фантаста
- Оклад: 25000-30000 руб.
- Регулярные расходы
- Научно-техническая библиотека им. Н. Г. Четаева
- TECHWRITER DAYS
Газета.Ру в соцсетях
Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov. Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов. Последние события в режиме онлайн: главные новости российского бизнеса и политики, международные события, криминальные происшествия, обзоры прессы, движения фондового рынка, лента спортивных новостей, автомобильные новости.
День из жизни технического писателя.
В экспозиции представлены интерьеры литературного салона времен первой половины XIX века, а также произведения скульптора Алекс андра Бурганова, пос вященные поэту. Вход по билетам. Для юных москвичей праздничные мероприятия, посвященные Дню писателя, пройдут в городских библиотеках. Вход для всех участников свободный, без предварительной регистрации. Чтобы не пропустить интересные и познавательные события 3 марта, за анонсами можно следить в разделе «Афиша» на портале mos. Кроме того, информация будет публиковаться на официальных сайтах библиотек.
Культурный центр «Содружество» Рижский проезд, д. Юным гостям расскажут о жизни и творчестве Александра Пушкина и Корнея Чуковского. Всем гостям вместе с ведущими предстоит прочесть «Сказку о рыбаке и рыбке». В конце встречи ребят ждут познавательные игры. Им зададут вопросы по классическим и современным произведениям.
Это поможет ребятам вспомнить знаменитые русские сказки, повести и рассказы. Здесь пройдет занятие «С книгой назначена встреча…». Детям расскажут интересные факты из жизни русских писателей Александра Пушкина, Ивана К рылова, Аркад ия Гайдара, чьи ю билейные даты пришлись на текущий год. А еще библиотекари помогут гостям найти ответы на вопросы о том, кто такие писатели и в чем состоит их труд. Еще для ребят проведут конкурсы, в которых они смогут проявить свою эрудицию, начитанность и смекалку.
Начало в 11:00.
Созданием такой документации занимаются технические писатели. Технические писатели на самом деле занимаются более интересной работой, чем можно себе представить на первый взгляд. Должность технического писателя сочетает менеджерские и аналитические функции. Помимо всего прочего, специальность технического писателя еще и востребованная. Все больше компаний ищут специалистов на эту позицию: на момент публикации статьи на Head Hunter 435 вакансий по запросу «технический писатель», на Хабре — 75.
О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения Nota. Docs в компании Notamedia. В статье вы узнаете о горизонтальном и вертикальном росте техписа, а также о том, какой тип личности подходит на эту работу в зависимости от специфики проекта. Кто такие технические писатели в IT Технический писатель — это специалист, который создает документацию по сложному, технологическому продукту сайту, сервису, мобильному приложению и т. ЦА продукта может быть разная, начиная от пользователей сайта или мобильного приложения и заканчивая разработчиками. Документация бывает как для внешних пользователей пользователей сервиса , так и внутренних сотрудников компании.
Техническая документация позволяет пользователям быстрее понимать и эффективно использовать функциональность продукта. С кем взаимодействует технический писатель Над разработкой продукта в IT-компании работает проектная команда. И для подготовки документации технический писатель взаимодействует со всеми ее участниками: Разработчики. Технический писатель переводит понятные и прописные истины программиста на удобный для пользователя язык. Для этого он идет к разработчику и задает вопросы о том, как работает система. Для оплаты услуг субподрядчика или оплаты услуг компании нужны сопутствующие документы.
Технический писатель вместе с финансовым отделом участвует в разработке этих документов для заказчика и их приемке от субподрядчика. С ними технический писатель обсуждает логику создания продукта, которую те придумали для разработчиков. Иногда совместно с аналитиками технический писатель может создавать документацию для команды разработки. Взаимодействие с дизайнерами нужно для того, чтобы задокументировать те или иные решения по дизайну. Руководители проектов. С РП технический писатель взаимодействует для координации и контроля над соблюдением всех необходимых формальностей со стороны участников проекта.
Обеспечивает консистентность формальной части проекта. Цели работы технического писателя Работа в сфере заказной разработки — это командный вид спорта, поэтому цель работы технического писателя — это успех всей команды, всего проекта. Антицель — написать красивый документ по ГОСТу, по которому невозможно провести испытания демонстрацию продукта заказчику , либо который не коррелируется с разработанной функциональностью продукта. Поэтому технический писатель разрабатывает документацию для целей, которые должны совпадать с целями компании. Если он пишет отчетную документацию по конкретному проекту, то он должен тесно взаимодействовать с проектной командой и осознавать, что разработанная функциональность будет приниматься заказчиком именно на основе написанной им отчетной документации. А ошибки в отчетной документации приводят к провалу испытаний или вовсе к отказу в приемке работ.
Для технического писателя важно не зацикливаться на самом тексте, а смотреть в суть. Прийти к разработчику и спросить: «Все ли я правильно понял и написал? Еще один важный момент — технический писатель должен не только предоставить заказчику комплект отчетной документации, но и согласовать ее с ним.
Вот чем будет полезно техническое образование: — технический склад ума и системное мышление — отличные спутники в IT-сфере; — навыки программирования помогут понимать разработчиков; — опыт написания материалов технической направленности пригодится, чтобы формулировать сложные вещи простыми словами. Образование лингвиста и знание фундаментальных основ языка помогут сделать тексты логичными и понятными для пользователя. И любое высшее образование научит добывать, отбирать и структурировать информацию, критически мыслить и быстро ориентироваться. Есть и базовый набор умений, которые не зависят от образования, но сильно упростят техпису жизнь: Грамотность.
Теоретически неграмотный технический писатель может существовать, но ему будет нелегко. Конечно, при вычитке все ошибки найдутся и исправятся, но важно самостоятельно уметь превращать свои мысли в грамотные предложения. Техпис постоянно общается с разными людьми. С кем-то это легко и просто, а из кого-то информацию нужно добывать. Сложно представить на месте технического писателя интроверта, которого приводит в ужас мысль, что надо разговаривать. Например, заказчик говорит, что ему нужна документация. У него есть макеты в «Фигме» и примерный флоу процесса.
Выглядит так, будто для полноценной документации этого недостаточно. Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст. Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно. Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру.
Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям. Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются. Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель. У разработчиков есть код-ревью.
У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной. И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай».
Каким может быть туториал в мобильном приложении? Что писать в справке к приложению? Будут ли пользователи читать сопроводительную документацию на сайте?
Как организовать пополнение FAQ? Почему техрайтер должен участвовать в создании онбординга?
Один день технического писателя
Специальность технический писатель появилась не так давно, однако уже является востребованной. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. Всемирный день писателя отмечается не только литераторами, но и редакторами, корректорами, критиками, культурологами, журналистами и другими людьми, чья работа связана со словом. Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. Последние события в режиме онлайн: главные новости российского бизнеса и политики, международные события, криминальные происшествия, обзоры прессы, движения фондового рынка, лента спортивных новостей, автомобильные новости.
Текст как призвание
- «День с писателем».
- Блог НПО "Компьютер": Один день из жизни технического писателя
- Всемирный день писателя – 3 марта!
- История профессии технического писателя
- Зачем техписам конференции?
- АНОНС: TechWriter Days – Международная конференция технических писателей