Опыт работы в аналогичной должности (или инженером – электроником) от одного года. Киножурнал "Новости дня" выходил с 1944 по 1983 годы. К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты о писателе, который считается и русским, и американским. Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации.
Один день из жизни технического писателя. Среда.
Часто писала по 6-7 страниц текста, а не сделать ошибок в таких длинных текстах сложно". Вообще, отношения с ней были слегка натянутыми. А с русским и литературой, наоборот. Поэтому какое-то время мечтала стать писателем.
Работа без выходных и перерывов Аренда манипуляторов в Москве и Московской области Краны-манипуляторы используют в различных сферах грузоперевозки, погрузка-разгрузка, высотные, строительные работы и пр. Выбор спецтехники зависит от различных параметров: габариты, грузоподъемность, высота подъема и др. Услуга аренды манипулятора — наиболее выгодный вариант в случае, если он необходим для решения краткосрочной задачи. Наша компания предлагает заказать аренду манипулятора в Москве и Московской области в любое удобное для клиента время. Мы гарантируем подачу техники на объект в течение 30 минут.
Во многом тексты Олега Рябова автобиографичны — в них есть близкие ему люди и места. Так и новый роман автора — "Позови меня, Ветлуга" о зове Родины, на который откликаются герои — пусть даже неосознанно. Так, по мнению Олега Рябова, хороший писатель должен, в первую очередь, писать. Во-вторых, писать надо правдиво. И еще один важный момент — автор должен быть в курсе литературного процесса, знать мастеров прошлого и будущего.
Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы. Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД.
Есть руководства пользователя с подробным описанием каждой кнопки интерфейса. Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке. Но в любом случае писатель должен быть внимательным, аккуратным и педантичным. Клиент всегда прав — отгрузка до 23. Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу.
Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены. Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы. Большие надежды — портал bercut. К примеру, поиск нужной информации можно выполнять только в рамках одного PDF-файла. Нельзя поискать описание какого-то параметра сразу во всей документации по системе. Это очень неудобно, ведь количество документов на одну систему часто исчисляется десятками. Если не знать, в каком документе искать нужные данные, то поиск превращается в нетривиальную задачу. Сейчас мы работаем над созданием портала, на который сможем выгрузить документацию в формате HTML.
Там будет предусмотрен удобный полнотекстовой поиск по всем страницам или по части документации, например, по страницам на определенную версию определенной системы. Да здравствует Команда! Также по пятницам у нас обычно проходит еженедельное совещание нашей команды в Skype. Эта традиция появилась у нас с переходом на удалённый режим работы. На совещании наш Team Lead делится с нами свежими новостями компании Bercut, рассказывает о новых краткосрочных и долгосрочных задачах и планах. Писатели по очереди рассказывают о своих задачах и рабочих проблемах — что сделано за прошедшую неделю, что планируется сделать на следующей. Такое обсуждение помогает нам скоординировать свои действия, ведь часто над пакетом документов к очередной версии системы работает сразу несколько писателей. Последний штрих Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Конечно, мы часто выполняем промежуточные синхронизации и в середине дня, но вечером обязательно проверяем, все ли изменения выгружены на сервер.
Будет обидно, если вся работа, сделанная за день, пропадет даром.
День технического писателя
Делали его первопроходцы и таежники для того, чтобы белеющая на стволе дерева мета была видна издалека, и ходили по тайге от меты к мете, часто здесь получалась тропа, затем и дорога, и где-то в конце ее возникало зимовье, заимка, затем село и город». На выставке представлено первое издание «Затесей» 1972 года. Всего писатель создал свыше двухсот художественных произведений, которые издавались более ста раз почти в тридцати странах. Экспозиция состоит из пяти разделов, каждый из которых носит название географических мест, где жил и работал писатель. Они были не только частью биографии Астафьева, но и неизменно присутствовали в его произведениях. Раздел «Игарские затеси» рассказывает о детских годах жизни драматурга и его трудах, в которых описывается заполярный город Игарка.
Интерес представляет уникальное издание «Игарские затеси» Валентины Гапеенко. В нем можно найти первую публикацию о литературном творчестве школьника Виктора Астафьева в газете «Большевик Заполярья» 1939 г. Представлено одно из первых произведений писателя «Васюткино озеро».
Менеджер принимает заказы круглосуточно, поэтому мы свяжемся с вами в течение 5 минут. Обсудим условия, ответим на любой вопрос, поможем выбрать подходящую под параметры и требования модель и договоримся о времени подачи на площадку. Предварительно назовем точную стоимость, пропишем ее в договоре — вам не придется ничего доплачивать в процессе или после выполнения работ. Для постоянных клиентов всегда действует специальная скидка.
При аренде крана-манипулятора вам не придется покупать технику под разные работы, и вы сможете максимально сэкономить.
Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Один в поле не воин Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают.
Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику. На поверку становись! Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики.
Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации. Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего.
В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы. Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД. Есть руководства пользователя с подробным описанием каждой кнопки интерфейса. Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке.
В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке. Но в любом случае писатель должен быть внимательным, аккуратным и педантичным. Клиент всегда прав — отгрузка до 23. Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу.
Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены. Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы.
В 1924-1925 годах художник занимался рисованием рекламных киноплакатов для таких фильмов, как «Девушка в маске», «Куртизанка», «Жена фараона» и многие другие.
Достаточно известен плакат Сутеева к ленте «Веселые ребята» , который он создавал вместе с Дмитрием Бабиченко. В 1928-м году мужчина начал работать на кинофабрике «Межрабломфильм». Спустя несколько лет Владимир поставил первый звуковой советский мультфильм под названием «Улица поперек».
Профессия технический писатель: чем занимается и как проходит типичный рабочий день
Технические писатели. Должность: технический писатель, хотя в последнее время скорее knowledge manager. Роль технического писателя Технический писатель переводит «от разработчика – клиенту». Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны.
Новости дня
Мы все очень разные: по возрасту, характеру, увлечениям и образованию. Но нас объединяет одно общее интересное дело — документирование сложных систем и решений. Бэкграунд Меня зовут Александр Клименков, я — ведущий технический писатель, кандидат технических наук по специальности «Системный анализ, управление и обработка информации», закончил Санкт-Петербургский электротехнический университет «ЛЭТИ». В компании Bercut работаю более 5 лет, очень люблю свою профессию. До прихода в Bercut работал преподавателем, техническим писателем и ведущим бизнес-аналитиком. Процессы и коммуникации в новой дистанционной реальности Как и большинство наших коллег в IT-сфере, сейчас мы работаем из дома. Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись. Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами. Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах. Биоритмы и конвенции Режим рабочего дня, как и процессы, тоже не особо изменился.
Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11. Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время. В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы. Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN. Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день. У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть.
Об этом нужно рассказать подробнее. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах.
Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки.
Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей. UnaDesk Специализированное программное обеспечение для автоматизированного создания сценариев работы пользователей в ИТ-системах и, на базе этих сценариев, создания учебных материалов, симуляций и документации для пользователей различных ИТ-систем, что позволяет сопровождать пользователя по всем шагам, необходимым для выполнения бизнес-процесса в ИТ-системах Подробнее Российский разработчик системы для быстрого освоения корпоративного ПО HintEd Платформа интерактивного обучения работе в корпоративном ПО. Обучающий слой поверх любого ПО: браузерного, или в виде отдельных Windows-приложений. Экзамус Экзамус разработал технологию, которая анализирует поведение пользователей любых онлайн-сервисов с помощью распознавания лиц и обнаружения эмоций. Для работы с продуктом достаточно наличия у пользователя мобильного устройства или компьютера с веб-камерой.
Кто такие технические писатели и зачем они нужны в команде Кто такие технические писатели и зачем они нужны в команде 07 июля 2021 Статьи Когда IT-продукт готов, нужно сделать так, чтобы им было удобно пользоваться — специалистам, которые будут его поддерживать, вносить в него изменения и пользователя. Для этого нужна техническая документация — она дает ответы на часто задаваемые вопросы и позволяет не тратить лишнего времени на поиск нужной информации. Технические писатели и есть те люди, кто раскладывает всю эту информацию по полочкам. Главная задача технического писателя — четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть. Такого рода инструкции как правило читают: инженеры, которые поддерживают программы или дорабатывают их; пользователи разного уровня подготовки, для которых эти программы и создаются. Инженеру может быть непонятно, как именно работает код, почему систематизация данных происходит именно по предложенным алгоритмам и как автоматизирован процесс. Обычным пользователям может быть трудно разобраться с последовательностью действий, понять, можно ли отменить операцию и как это сделать, как настроить быстрый доступ к самым нужным функциям, какие кнопки для этого созданы. Инженеры найдут ответы в сопровождающей технической документации, пользователи посмотрят инструкцию, написанную к программе, или зайдут в раздел «Помощь» или FAQ. Часто люди обращаются к инструкциям только тогда, когда становится совсем непонятно или что-то идет не так. Хорошо, если это произойдет до того, как что-нибудь будет сломано, иначе скажут — продукт плохой. Технический писатель должен предусмотреть такие ситуации: предупредить о возможной поломке, описать ее, предложить решение. Что делает технический писатель Профессиональные знания, умения и навыки технических писателей конкретизированы и уточнены сообразно отраслевой и профессиональной специфике в Профстандарте технического писателя. Проекты разные, и набор того, что и для кого задокументировать, не всегда одинаковый. Одному проекту достаточно подробной инструкции для технических специалистов, другим потребуется пакет документов и для поддержки, и для обычных пользователей. Технические тексты считаются хорошими, если написаны точно, последовательно, но при этом кратко и понятно. В таких текстах важно, чтобы информация была структурированной, чтобы в них были списки, таблицы, схемы. Часто именно небольшой список помогает пользователю быстрее, чем длинное описание на двадцати страницах. В технических текстах обычно много иллюстраций, скриншотов интерфейсов, видео. Это нужно, чтобы человек сравнил картинку на инструкции с тем, что видит на мониторе, понял, что действует правильно, и настроил систему по шагам на картинках «В моей работе главное ориентироваться на конечного потребителя: как с помощью технической документации он будет решать свои задачи, какой у него уровень подготовки и насколько подробно все должно быть заложено в инструкции. К примеру, я сейчас работаю над частью внутренней информационной системой, которой будут пользоваться технические специалисты. Поэтому основные требования — подробная и длинная инструкция с множеством скриншотов и примеров, которые позволят пользователю решить разные задачи. А в другом проекте я пишу небольшую часть документации по функциональности продукта для обычных пользователей. Здесь тексты простые, информативные и доступные. Моя основная задача — сделать так, чтобы и системный администратор, и обычный пользователь нашли в инструкции то что ищут и этот поиск не занял много ресурсов». Приступая к написанию любой инструкции, технический писатель анализирует многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Самый главный источник — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. Технический проект — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
Спецификации, справочная информация для разработчиков, внутренняя документация для взаимодействия внутри команд и между ними, корпоративные базы знаний — не прямая обязанность, но часто перепадает именно на долю технического писателя или он как минимум всё это проверяет, упорядочивает и доводит до ума. UX-тексты подсказки, пункты меню, и т. Технические переводы с русского на иностранный и обратно — чаще всего именно задача техписа, но здесь есть нюанс с владением языками, поэтому нередко ему помогают переводчики особенно в мультиязычных компаниях. Теодора Малевинская Держатель профессии «технический писатель» в Тинькофф О себе: Строю техписательские процессы для разработчиков, собираю редакции, развиваю профессиональное сообщество в компании и вне. Я очень люблю обращаться к статистике — это аргументы, которые я часто привожу: Исследование 1 В 2016 StackOverflow провёл исследование среди разработчиков о том, с какими проблемами они сталкиваются в работе. Исследователи делают вывод: «Это показывает как важно для компаний иметь хорошо написанную документацию». Исследование 3 Nintex проводили исследование о самых неэффективных процессах в ИТ-компаниях. Я сама наблюдаю, что часто такая проблема бывает из-за того, что какие-то ошибки или процессы не описаны в документации. Источник В целом мы видим, что разработчики читают документацию, но большинство сталкивались с проблемой: её не было или она была неполной. Плохая документация — это неоправданно дорого для компаний. Особенно, если она к продукту, которым пользуются многие. За последние четыре года не раз видела случаи, когда технический писатель переписывал инструкцию и экономил часы и дни разработчиков. Например, техписатель понятно переписал онбординг, который прошли 500 человек. Это заняло у них 3 дня, а не 5. Оставшиеся 8000 часов можно потратить на разработку фич или ещё что-то полезное для компании, ведь теперь им не надо писать вопросы в чат поддержки. Что должен знать и уметь технический писатель? Это тоже зависит от компании, продукта и существующих задач, но мы с вами обратимся к Хабр Карьере и посмотрим, что требует рынок. Есть почти во всех вакансиях в той или иной мере. В любом случае знание ГОСТ сильно облегчает работу и дарит навык структурирования. Навыки сбора и анализа информации. Навыки сбора и анализа, а также описания требований — да, с требованиями техническим писателям приходится работать часто, и там есть серьёзные нюансы сбора, агрегации и «просеивания» собранной информации. Способность работать структурировать, перерабатывать с большими объёмами информации — и с каждым годом всё больше. Аккуратность, внимание к деталям. Умение писать легко и понятно — пользователи разные, и информация должна быть доступная каждому. Отличное знание русского языка. Знание английского языка — как значительное преимущество, а часто и строго обязательное требование. Мария Смирнова О себе: деловой телеграм Есть расхожая фраза про то, что технические писатели — это «переводчики с разработческого на пользовательский».
Наука и техника
О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. Должность: технический писатель, хотя в последнее время скорее knowledge manager. 120 лет со дня рождения писателя Владимира Григорьевича Сутеева/. Иркутского Государственного Технического Университета ISSN. Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов.
День технического перевода
| Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23 | Служба безопасности День. Табло. Глобалисты провоцируют жёсткие санкции. |
| Новости науки, техники и технологий - | Опыт работы в должности бизнес-аналитика или технического писателя от 1 года. |
| День писателя | Новости портала "Российское образование" | Andrei Serikov in Технические писатели. |
| Новости дня – «ВЗГЛЯД.РУ» | Поэтому какое-то время мечтала стать писателем. |
366. День технической книги
Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. Кастинг, вакансия для ДРУГОЕ: (Удаленка) Требуется технический писатель. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. Роль технического писателя Технический писатель переводит «от разработчика – клиенту».
НОВОСТИ ДНЯ
Последний роман Набокова «The Original of Laura» писатель завещал сжечь после его смерти, но его желание не было исполнено и первое издание вышло в 2009 году. В апреле 1919 года, перед захватом Крыма большевиками, семья Набоковых навсегда покинула Россию. Набоков получал образование в Кембриджском университете Тринити-колледж , где он продолжал писать русские стихи и переводить на русский язык «Алису в Стране чудес» Льюиса Кэрролла. В Кембриджском университете Набоков основал Славянское общество, впоследствии переродившееся в Русское Общество Кембриджского университета. В Берлине он зарабатывал на жизнь уроками английского языка. В берлинских газетах и издательствах, организованных русскими эмигрантами, печатались рассказы Набокова. Романы Набокова, не печатавшиеся в Советской России, имели успех у западной эмиграции, и ныне считаются шедеврами русской литературы особенно «Защита Лужина», «Дар», «Приглашение на казнь». В Америке с 1940 до 1958 года Набоков зарабатывал на жизнь чтением лекций по русской и мировой литературе в американских университетах.
С 1938 года и до конца своих дней Набоков не написал на русском языке ни одного романа.
Сегодня речь пойдет о еще одной востребованной и интересной, но пока редкой профессии. Технический писатель — специалист, находящийся на стыке двух областей: он должен хорошо знать язык, на котором пишет, и разбираться в технологиях, о которых пишет. Мы живем в век высоких технологий, поэтому сфера IT — одна из наиболее развивающихся в современном мире. Впервые сталкиваясь с каким-нибудь новым устройством и открывая инструкцию по пользованию, вот здесь мы и видим работу технического писателя technical writer , задача которого — донести до простого пользователя сложную техническую информацию понятным, «человеческим» языком.
И то, будет ли информация из справки нам полезна, а в конечном итоге — каково будет наше впечатление о новом продукте, во многом зависит от квалификации технического писателя.
Обучение В учебных организациях отсутствует обучение на профессию технического писателя. Чтобы начать карьеру технического писателя необходимо закончить высшее техническое образование. Главной целью для технического писателя является объяснить пользователю, как обращаться с приборами или компьютерными программами доступным и понятным языком.
Иногда не лишним будет добавить картинки, анимации, пользуясь графическими программами, чтобы более наглядным способом объяснить пользователю возможности прибора. Плюсы и минусы Из плюсов профессии выделяются высокая востребованность на рынке труда, достойная заработная плата, возможность трудиться удалённо, работа с новыми программами или приборами позволит повысить кругозор, разобраться и понять, что они из себя представляют и чем могут быть полезны. Из отрицательных сторон деятельности нужно сказать о высокой ответственности, большую ограниченность в написании текстов, множество требований, которые надо исполнять.
Часто именно небольшой список помогает пользователю быстрее, чем длинное описание на двадцати страницах. В технических текстах обычно много иллюстраций, скриншотов интерфейсов, видео. Это нужно, чтобы человек сравнил картинку на инструкции с тем, что видит на мониторе, понял, что действует правильно, и настроил систему по шагам на картинках «В моей работе главное ориентироваться на конечного потребителя: как с помощью технической документации он будет решать свои задачи, какой у него уровень подготовки и насколько подробно все должно быть заложено в инструкции. К примеру, я сейчас работаю над частью внутренней информационной системой, которой будут пользоваться технические специалисты. Поэтому основные требования — подробная и длинная инструкция с множеством скриншотов и примеров, которые позволят пользователю решить разные задачи. А в другом проекте я пишу небольшую часть документации по функциональности продукта для обычных пользователей.
Здесь тексты простые, информативные и доступные. Моя основная задача — сделать так, чтобы и системный администратор, и обычный пользователь нашли в инструкции то что ищут и этот поиск не занял много ресурсов». Приступая к написанию любой инструкции, технический писатель анализирует многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Самый главный источник — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. Технический проект — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца.
Только так получится хорошая и качественная документация. Процесс работы технического писателя. Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство.
На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам.