Рассказываем о профессии технического писателя: обязанности, задачи, навыки, которые пригодятся для работы.
Февральская встреча Сообщества технических писателей Санкт-Петербурга
Но, к сожалению, так бывает редко. Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя.
Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз». Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию. Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов. Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров». Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно.
Может быть, после некоторого размышления, он догадается, что все эти названия описывают одно и то же. Но мы же любим наших пользователей, зачем постоянно заставлять их решать подобные головоломки? Есть ещё одна важная особенность технических текстов: кроме правильного употребления общих терминов важны также фигуры описания. Так называются повторяющиеся фрагменты небольшого размера — словосочетания или короткие простые предложения. Например: «Функция … доступна в следующих режимах …» «Чтобы …, выполните в приложении … следующие действия: …» «Задайте системный параметр …» Для фигур описания иногда составляют отдельные словари или справочники. Казалось бы, мелочь. Но пользователь привыкает к определённым конструкциям и фразам.
Если в одном месте документа написано «Выберите режим», а в другом «Перейдите в режим», у пользователя может возникнуть сомнения: здесь описано одно и то же действие или разные? Задача технического писателя — унифицировать весь тот зоопарк формулировок и терминов, которые употребляют в своих документах аналитики, разработчики и другие участники процесса разработки ПО. У технических писателей обычно есть свои словари терминов и фигур описания. Опытный писатель разбирается в системе и понимает, что именно означает тот или иной жаргонный термин во внутреннем документе.
Когда и где: 4-5 июня, София, Болгария. Knowledge Conf 2024 Программа конференции Knowledge Conf охватывает широкий спектр аспектов управления знаниями. В ее рамках рассматриваются как прикладные задачи, включающие в себя обучение новичков, организацию базы знаний, создание внутренних университетов, а также практическое обучение, так и фундаментальные аспекты, такие как применение современных методов обучения и развитие системного мышления. Мероприятие позиционируется как профессиональная конференция по управлению знаниями и ее программа отражает этот слоган. Когда и где: 27-28 июня, Санкт-Петербург, РФ.
Целью конференции является распространение существующих и создание новых знаний об архитектуре программных решений. Несмотря на то, что данное мероприятие не ориентировано на технических писателей, некоторые темы докладов могут быть интересны и им. Конференция также будет проводиться онлайн, что позволит участвовать в ней без необходимости поездок. Когда и где: 1 ноября, Москва, РФ. Зачем техписам конференции? Итак, зачем же всё-таки техническим писателям посещать конференции? Ниже приведены основные преимущества: Общение. Одним из ключевых преимуществ конференций для технических писателей является возможность встретиться с коллегами из индустрии. Это не только позволяет обсудить актуальные тенденции и вызовы в области технического писательства, но и обменяться опытом и лучшими практиками.
Встречи с единомышленниками могут стимулировать новые идеи и подходы к работе.
Новости 14 октября 2023 года Архангельская областная научная библиотека им. Добролюбова проводит седьмую областную акцию в поддержку книги и чтения «День с писателем».
Цель акции — продвижение лучших образцов российской и региональной литературы, повышение престижа библиотек, развитие читательской культуры жителей Архангельской области. В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского.
Но самой интересной частью встречи стала постановка пьесы «Снегурочка». Ребята с большим удовольствием выбирали роли и играли на импровизированной сцене. Встреча пришла очень интересно и познавательно. Навигация по записям.
История профессии технического писателя
Так и новый роман автора — "Позови меня, Ветлуга" о зове Родины, на который откликаются герои — пусть даже неосознанно. Так, по мнению Олега Рябова, хороший писатель должен, в первую очередь, писать. Во-вторых, писать надо правдиво. И еще один важный момент — автор должен быть в курсе литературного процесса, знать мастеров прошлого и будущего. В таком случае текст получится достойным.
Фаворского Московского Политеха Ольга Монина поделилась воспоминаниями из детства об Анатолии Митяеве: Мои детские и юношеские воспоминания о Митяеве укладываются в слово «улыбка». Он действительно улыбался везде, в том числе и на рабочем месте — в редакции журнала «Мурзилка».
Для меня самый тёплый «Мурзилка» — это именно митяевский «Мурзилка». Анжела Лебедева и Ольга Монина Режиссёр-мультипликатор Леонид Носарев отметил вклад Анатолия Митяева в детскую литературу: В некотором смысле Анатолий Митяев определил мою творческую судьбу: благодаря ему в моей жизни произошли судьбоносные встречи, в том числе с замечательным писателем Юрием Ковалём. Эта замечательная выставка рассказывает нам о писателе и человеке, который понимает, чувствует, любит. Он оставил после себя творчество, которое необходимо, прежде всего, нашим детям. Нужно обязательно знакомить детей с произведениями Анатолия Митяева, они хрестоматийные.
В данной картине впервые был использован альбомный метод мультипликации. В 1924-1925 годах художник занимался рисованием рекламных киноплакатов для таких фильмов, как «Девушка в маске», «Куртизанка», «Жена фараона» и многие другие. Достаточно известен плакат Сутеева к ленте «Веселые ребята» , который он создавал вместе с Дмитрием Бабиченко. В 1928-м году мужчина начал работать на кинофабрике «Межрабломфильм».
Перерыв у вас будет возможность получить рекомендации по профессиональному развитию, поделиться своими проблемами, обсудить ситуацию на трудовом рынке и поспорить о роли писателей в меняющемся мире IT Круглый стол "Документация и справка мобильных приложений" с 20 ч. Мы обсудим вопросы: Какие новые термины из области мобильной разработки должен знать техрайтер? Необходимо ли техническое задание на мобильное приложение? Каким может быть туториал в мобильном приложении? Что писать в справке к приложению?
Профессия технический писатель: чем занимается и как проходит типичный рабочий день
Andrei Serikov in Технические писатели. Известный нижегородский писатель Валерий Шамшурин так сказал о нем. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов.
Все новости
К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты о писателе, который считается и русским, и американским. Andrei Serikov in Технические писатели. Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля.
: техническим писателем ✒
Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах.
Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей.
Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira.
У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов.
Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много.
Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики.
Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Теоретически неграмотный технический писатель может существовать, но ему будет нелегко. Конечно, при вычитке все ошибки найдутся и исправятся, но важно самостоятельно уметь превращать свои мысли в грамотные предложения.
Техпис постоянно общается с разными людьми. С кем-то это легко и просто, а из кого-то информацию нужно добывать. Сложно представить на месте технического писателя интроверта, которого приводит в ужас мысль, что надо разговаривать.
Например, заказчик говорит, что ему нужна документация. У него есть макеты в «Фигме» и примерный флоу процесса. Выглядит так, будто для полноценной документации этого недостаточно.
Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст. Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно.
Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру.
Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям. Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются.
Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель.
У разработчиков есть код-ревью. У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной.
И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай». Как понять, что работа мне подходит Возьмите приложение любимого банка и напишите инструкцию к какому-то простому процессу. Например, как оплатить мобильную связь.
Покажите эту инструкцию друзьям или родителям, попросите проверить и попробовать пополнить баланс, следуя ей. Если инструкция сработала — поздравляю, это прекрасный старт, вы готовы к тестовым заданиям.
Технические переводы с русского на иностранный и обратно — чаще всего именно задача техписа, но здесь есть нюанс с владением языками, поэтому нередко ему помогают переводчики особенно в мультиязычных компаниях. Теодора Малевинская Держатель профессии «технический писатель» в Тинькофф О себе: Строю техписательские процессы для разработчиков, собираю редакции, развиваю профессиональное сообщество в компании и вне. Я очень люблю обращаться к статистике — это аргументы, которые я часто привожу: Исследование 1 В 2016 StackOverflow провёл исследование среди разработчиков о том, с какими проблемами они сталкиваются в работе.
Исследователи делают вывод: «Это показывает как важно для компаний иметь хорошо написанную документацию». Исследование 3 Nintex проводили исследование о самых неэффективных процессах в ИТ-компаниях. Я сама наблюдаю, что часто такая проблема бывает из-за того, что какие-то ошибки или процессы не описаны в документации. Источник В целом мы видим, что разработчики читают документацию, но большинство сталкивались с проблемой: её не было или она была неполной. Плохая документация — это неоправданно дорого для компаний.
Особенно, если она к продукту, которым пользуются многие. За последние четыре года не раз видела случаи, когда технический писатель переписывал инструкцию и экономил часы и дни разработчиков. Например, техписатель понятно переписал онбординг, который прошли 500 человек. Это заняло у них 3 дня, а не 5. Оставшиеся 8000 часов можно потратить на разработку фич или ещё что-то полезное для компании, ведь теперь им не надо писать вопросы в чат поддержки.
Что должен знать и уметь технический писатель? Это тоже зависит от компании, продукта и существующих задач, но мы с вами обратимся к Хабр Карьере и посмотрим, что требует рынок. Есть почти во всех вакансиях в той или иной мере. В любом случае знание ГОСТ сильно облегчает работу и дарит навык структурирования. Навыки сбора и анализа информации.
Навыки сбора и анализа, а также описания требований — да, с требованиями техническим писателям приходится работать часто, и там есть серьёзные нюансы сбора, агрегации и «просеивания» собранной информации. Способность работать структурировать, перерабатывать с большими объёмами информации — и с каждым годом всё больше. Аккуратность, внимание к деталям. Умение писать легко и понятно — пользователи разные, и информация должна быть доступная каждому. Отличное знание русского языка.
Знание английского языка — как значительное преимущество, а часто и строго обязательное требование. Мария Смирнова О себе: деловой телеграм Есть расхожая фраза про то, что технические писатели — это «переводчики с разработческого на пользовательский». При всей её заезженности и радикальности я скорее склонна с этим тезисом согласиться. Не в последнюю очередь из-за того, что я сама не только технический писатель, но и переводчик.
Ребята познакомились с биографией писателя. Узнали интересные факты из его жизни. Но самой интересной частью встречи стала постановка пьесы «Снегурочка». Ребята с большим удовольствием выбирали роли и играли на импровизированной сцене.
#Кем стать: Техническим писателем
В Новом здании Российской национальной библиотеки (Московский пр., д.165 к.2) начала работу выставка «Затеси» Виктора Астафьева», приуроченная к 100-летнему юбилею русского писателя и драматурга. О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты о писателе, который считается и русским, и американским. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. Самые свежие новости России и мира, новости политики, шоу-бизнеса.
День технического перевода
Websoft Разработчик программного обеспечения для автоматизации HR-процессов WebTutor Комплексная система управления обучением, оценкой и развитием персонала CourseLab Инструмент разработки электронных курсов любой сложности Виртуальный класс Система для проведения веб-семинаров Включает в себя пользовательский портал для централизованного хранения созданных документов, быстрого обновления всех форматов документации, поддержания в актуальном состоянии и обучения пользователей ИТ-системам и бизнес-процессам, а также сбора соответствующей аналитики и оценки знаний и уровня цифровой адаптации пользователей. Решение упрощает обучение сотрудников ИТ-системам и сокращает трудозатраты экспертов по разработке и актуализации пользовательской документации. Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей. UnaDesk Специализированное программное обеспечение для автоматизированного создания сценариев работы пользователей в ИТ-системах и, на базе этих сценариев, создания учебных материалов, симуляций и документации для пользователей различных ИТ-систем, что позволяет сопровождать пользователя по всем шагам, необходимым для выполнения бизнес-процесса в ИТ-системах Подробнее Российский разработчик системы для быстрого освоения корпоративного ПО HintEd Платформа интерактивного обучения работе в корпоративном ПО. Обучающий слой поверх любого ПО: браузерного, или в виде отдельных Windows-приложений.
Сегодня мне нужно описать работу новой программы. Список отбираемых работ берется не наобум.
Ежедневно никто не станет напоминать, что тебе нужно описать. Процессом планирования занимается сам технический писатель: пересматривает документы отделов разработки что сделали, как это работает , открывает тестовые разработанные программы смотрит и вручную проверяет их работу. И из всей полученной информации выбирает только то, что влияет на документацию. Теперь я создаю документ, в котором буду разрабатывать описание программы. Перед началом описания необходимо изучить функционал. То, как вы поймете его изначально, повлияет на качество текста в целом.
Чтобы посмотреть, как работает программа, запрашиваю ее в отделе разработки. Для начала в документе создаем примерную структуру — в какой книге будет располагаться новый текст, какие разделы появятся, что они будут в себя включать. Книги обычно подразделяются на руководства для пользователя, администратора и разработчика. В зависимости от этого, описание выполняется на языке, понятном представителю одной из ролей. Например, для пользователя нужно писать «простым» языком, давать подробный порядок действий, для разработчика, напротив, нужны четкие формулировки с терминами, описание рабочих примеров кода. Вам сложно понять, что нужно писать, с чего начинать, как писать?
Не переживайте. Для каждого типа описываемого объекта, например, справочник, сценарий или установка, имеется отдельный формат описания. Формат задает структуру описаний, предоставляет готовые типовые фразы, правила оформления текста.
Демонстрировался в кинотеатрах перед киносеансами. Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы.
Клиент SuperJob с 2021 годаБолее 100 сотрудников Деятельность в сфере гидрометеорологии и мониторинга окружающей среды. Вакансия перемещена в архив Вероятно, эта вакансия закрыта. Но у нас есть много других похожих вакансий, которые могут Вас заинтересовать.