5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей «TechWriter Days». Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Andrei Serikov in Технические писатели. #Кем_стать: техническим писателем Много знать и доходчиво излагать свои мысли, уметь писать и одновременно разбираться в технике и технологиях, чтобы сложные вещи объяснить простым и понятным языком – работа технического писателя Работа эта стоит дорого. Известный нижегородский писатель Валерий Шамшурин так сказал о нем.
День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными Интересные факты об известных писателях: Настоящее имя Корнея Чуковского — Николай Васильевич Корнейчуков. При рождении он получил фамилию матери, но с первой же статьи стал подписываться псевдонимом Корней Чуковский. За всю жизнь Антона Чехова ни разу не видели в неопрятном виде. Он всегда следил за своей внешностью и даже за произведения садился, облачившись в парадный костюм.
Employees can enhance their knowledge and skills, which, in turn, can improve the quality and efficiency of technical documentation creation. Experience Sharing and Networking. The conference offers a unique opportunity to exchange experiences with colleagues from other companies. 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.
Новгород: изд-во «Книги», 2004. Гофман, В. Новгород, 1998. Новгород, 2000. Сборник 1. Гофман, Т. Панченко, Б. Новгород: «Эльдорадо», 224 с. Нижний Новгород: изд-во «Книги», 2009. Новгород, 1999. Ночные костры; Ю. Странноприимный дом.
Знание серии докуметов ГОСТ 2 желательно с применением на практике. Для работы требуются навыки делового общения как внутри организации, так и с заказчиками и исполнителями работ вне центра; работа в космической отрасли является преимуществом; Желательно обладать базовыми знаниями в области информационных технологий; Самоорганизованность, стрессоустойчивость. Работа в центре Москвы м.
Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
Наша аудитория — лидеры бизнеса и политики, чиновники, десятки тысяч горожан.
Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна. Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет. Но, к сожалению, так бывает редко. Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением.
Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз». Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию. Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов. Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров».
Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно. Может быть, после некоторого размышления, он догадается, что все эти названия описывают одно и то же. Но мы же любим наших пользователей, зачем постоянно заставлять их решать подобные головоломки? Есть ещё одна важная особенность технических текстов: кроме правильного употребления общих терминов важны также фигуры описания. Так называются повторяющиеся фрагменты небольшого размера — словосочетания или короткие простые предложения. Например: «Функция … доступна в следующих режимах …» «Чтобы …, выполните в приложении … следующие действия: …» «Задайте системный параметр …» Для фигур описания иногда составляют отдельные словари или справочники. Казалось бы, мелочь.
Но пользователь привыкает к определённым конструкциям и фразам. Если в одном месте документа написано «Выберите режим», а в другом «Перейдите в режим», у пользователя может возникнуть сомнения: здесь описано одно и то же действие или разные? Задача технического писателя — унифицировать весь тот зоопарк формулировок и терминов, которые употребляют в своих документах аналитики, разработчики и другие участники процесса разработки ПО.
За последнее время мы уже сделали несколько шагов для исправления ситуации: создали учебный курс , в котором много времени отводится на общение с преподавателем, ведём блог с полезными материалами и периодически организуем конференции. Но при этом «живого» общения всё равно остаётся очень мало, поэтому сейчас мы решили сделать ещё один шаг навстречу коммуникациям. Итак, мы объявляем о создании площадки для общения и обмена опытом между техническими писателями!
И называется она «Доквариум». Почему так? От «док» — документ и латинского суффикса «риум», что означает «дом», «место» как в «аквариум», «океанариум»…. То есть место для общения документаторов, которое со временем может стать нашим общим профессиональным «домом». По формату — это круглый стол в виде вебинара. То есть, участвовать смогут, как обычно, все желающие, независимо от города и даже страны.
Участие в наших встречах бесплатно. На первый раз у нас есть ограничение по количеству участников — 30 человек.
Смотрю расписание, а сзади меня уже крадется поезд: 21. Из окна можно лицезреть разные виды граффити - пошлые и не очень, красивые и страшные, милые и жуткие и много других. Однажды появился новый рисунок, я ехала грустная и злая, но увидела его и сразу разулыбалась. Интересных граффити больше нет, можно почитать. Некоторое время назад решила перечитать всего Достоевского, очень развивает Жаль, что заграницей этого писателя любят намного больше, чем у нас в России. Я не буду показывать и описывать свой день в офисе, он не отличается чем-то интересным.
Я сижу весь день уткнувшись в PHP-код, часто с угрюмым лицом, иногда среди тишины раздаются мои возгласы или возгласы программиста. Изредка смех технической поддержки и ооооооочень редко ворчание начальника. Конец рабочего дня официально в 7 вечера, но голова пухнет от компьютера и программного кода, меня ждет друг и я сбегаю из офиса. Время: 25. Мы встретились и решили пойти в Парк Горького, я давно не была и мне все рассказывали, как здорово там сейчас сделали. А еще я сначала совсем забыла, что нужно фотографировать всё вокруг и вспомнила только на милых уточках: 26. Этой мой друг. Друга зовут Максим.
Мы хотели покататься на лодках, но там была огромная очередь! Тогда мы решили пойти на набережную и разузнать, как ходят речные трамвайчики. Пока шли, я увидела судно интересного цвета: 28.
День технического писателя
Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. Сталин и писатели. День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. Поздравляем всех технических писателей страны с профессиональным праздником и желаем нескучных рабочих будней, отличного настроения и благодарных пользователей!
Технический писатель
Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. Рассказываем о профессии технического писателя: обязанности, задачи, навыки, которые пригодятся для работы. Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации. Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. Дневник писателя Ф. М. Достоевского.
«День с писателем».
Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия Всемирный день писателя отмечается не только литераторами, но и редакторами, корректорами, критиками, культурологами, журналистами и другими людьми, чья работа связана со словом. Технические писатели. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов.
Зачем нужны технические писатели
С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. Историю празднования Дня писателя узнают те, кто придет в библиотеку №107 (Перовское шоссе, д. 16/2). Киножурнал "Новости дня" выходил с 1944 по 1983 годы. Кастинг, вакансия для ДРУГОЕ: (Удаленка) Требуется технический писатель. Иркутского Государственного Технического Университета ISSN.
День технического перевода
В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева.
TECHWRITER DAYS
Так, по мнению Олега Рябова, хороший писатель должен, в первую очередь, писать. Во-вторых, писать надо правдиво. И еще один важный момент — автор должен быть в курсе литературного процесса, знать мастеров прошлого и будущего. В таком случае текст получится достойным.
Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись. Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами.
Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах. Биоритмы и конвенции Режим рабочего дня, как и процессы, тоже не особо изменился. Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11.
Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время.
В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы. Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN. Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день.
У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть. Об этом нужно рассказать подробнее.
Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Наш Toolkit позволяет собирать документы во множестве форматов.
При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием.
Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы.
Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки.
Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает.
Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira.
После окончания Томского технологического института он работал инженером-механиком, но увлекшись изобретательством, перешел работать во Всесоюзный научно-исследовательский институт электромеханики. Когда Александру Казанцеву было 35 лет, началась Великая Отечественная война. В армии он служил заместителем командира саперного батальона, причем в звании рядового.
Он предложил наладить выпуск для фронта дистанционно управляемых торпед-танкеток, его изобретение использовали во время прорыва блокады Ленинграда. Но самую ценную награду, именно за свою торпеду — специальную изобретательскую медаль, — я получил через полвека после войны», — рассказывал Александр Казанцев. Как писатель-фантаст Александр Казанцев дебютировал в 1936 году на конкурсе киносценариев.
Работе с системами и текстами я посвятил уже почти 25 лет, и могу с уверенностью сказать, что профессиональное выгорание — это не про меня. Моя специальность позволяет мне постоянно развиваться в разных направлениях, каждый день учиться чему-то новому, даже много лет проработав в одной компании. В мире разработки систем и ПО всё постоянно меняется — появляются новые технологии и отрасли, у систем появляются новые функциональные возможности. Но всегда будут нужны те, кто сумеют во всём этом разобраться и написать простой понятный текст для пользователей системы. Я уверен, что в ближайшие десятилетия профессия технического писателя не только останется нужной и востребованной, но будет обретать всё большую популярность и ценность на рынке. Текста больше, чем кода — Кто за сутки до отправки заказчику во всей инструкции заменил manual на manul?!
Давайте окинем взглядом весь процесс разработки программного обеспечения. Его главный результат — это, конечно, программный код. А его главными действующими лицами всегда были и будут программисты, что бы там ни говорили другие его участники. Но сам этот процесс попутно порождает большое количество текстовых артефактов. Тут и функциональные требования заказчика, и техническое задание, и многочисленные протоколы совещаний, и переписки в чатах, и комментарии к запросам в системе планирования задач, и, наконец, описание реализации. А ведь есть ещё многочисленные комментарии в коде, которые тоже содержат много нужной информации.
В общем, текстов хватает. Так зачем же тогда в самом конце разработки нужен ещё и технический писатель? Почему всех этих документов недостаточно для того, чтобы дать ответы на основные вопросы заказчика и пользователя: как работает система и как её настроить? Будем разбираться. Разработчики должны писать код, а не текст «Условие, что поле PART должно быть не пустым, обеспечивается целостностью процесса, заполняющего это поле, и не обеспечивается отдельным ограничением Oracle типа NOT NULL для обеспечения максимального быстродействия при изменении данных таблицы». Из внутренней документации проекта Бывает так, что программисты прекрасно разбираются в программе, досконально понимают все тонкости работы системы, но не могут красиво изложить всё это в текстовом виде.
Лично я убеждён, что в этом нет ничего плохого. Согласитесь, что даже текст, написанный с орфографическими и стилистическими ошибками, может быть понятным и успешно выполнять свою функцию — доносить до читателя мысль автора. А ошибки — это дело поправимое, коррекцию и правку текста при необходимости может выполнить редактор или тот же технический писатель. Главное — не допускать ошибок фактических. Каждый должен заниматься своим делом. Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон.
Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель.