5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей «TechWriter Days». Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех».
Конференции: полезный ресурс для технических писателей
С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. за профессионализм, признание професии и чистоту русского языка (и в технических документах тоже)! Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий.
День из жизни технического писателя.
Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. Опыт работы в качестве технического писателя в области разработки и внедрения информационных систем от 3х лет. Выходит, что технические писатели в пользовательской документации исправляют все недостатки, ошибки и неточности, допущенные во внутренней документации и метаданных в процессе проектирования и разработки системы. Опыт работы в качестве технического писателя в области разработки и внедрения информационных систем от 3х лет.
НОВОСТИ ДНЯ
К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты про писателя, который считается и русским, и американским. В одном из интервью он сказал о себе: «Я американский писатель, рожденный в России, получивший образование в Англии, где я изучал французскую литературу перед тем, как на пятнадцать лет переселиться в Германию». Владимира Набокова называют одним из самых гениальных русскоязычных и англоязычных писателей. Набоков - классик новейшей американской прозы, которого называют своим ближайшим предшественником К. Воннегут, Дж.
Барт, Т. Пинчон и Т. В русских литературных хрониках он существовал как «В. Так он подписаны первые, начала 1920-х годов, поэтические сборники «Гроздь», «Горний путь» и который сохранился вплоть до конца 1930-х.
Это могут быть инструкции для пользователей — например, разделы «Помощь» или FAQ на сайтах. А также сугубо технические спецификации, больше ориентированные на разработчиков или нужные для регистрации ПО в Росреестре. Эта профессия находится на стыке гуманитарного и технического.
В какую сторону перевес — зависит от деятельности компании и конечного пользователя: можно писать инструкции к газовым котлам, а можно описывать миграцию данных. Даже если отбросить газовые котлы и остаться только в айти, документация по-прежнему будет разной. Её разделяют на внутреннюю и внешнюю, пользовательскую и разработческую, по гостам и нет.
От целей документации зависит её язык, глубина раскрытия и много других подробностей. Описание миграции данных Какие знания и навыки нужны Российские университеты не выпускают готовых технических писателей. Поэтому сложно сказать однозначно, какое образование подходит, чтобы стать техписом.
Компании примерно поровну хотят техписов-гуманитариев и техписов-технарей — опять же в зависимости от специфики проекта и назначения технической документации. Я по образованию журналист. И считаю, что диплом сыграл в мою пользу, потому что: — умею работать с текстами;— знаю, как брать интервью и превращать его в интересный рассказ; — умею добывать и обрабатывать информацию.
Вот чем будет полезно техническое образование: — технический склад ума и системное мышление — отличные спутники в IT-сфере; — навыки программирования помогут понимать разработчиков; — опыт написания материалов технической направленности пригодится, чтобы формулировать сложные вещи простыми словами. Образование лингвиста и знание фундаментальных основ языка помогут сделать тексты логичными и понятными для пользователя. И любое высшее образование научит добывать, отбирать и структурировать информацию, критически мыслить и быстро ориентироваться.
Есть и базовый набор умений, которые не зависят от образования, но сильно упростят техпису жизнь: Грамотность. Теоретически неграмотный технический писатель может существовать, но ему будет нелегко. Конечно, при вычитке все ошибки найдутся и исправятся, но важно самостоятельно уметь превращать свои мысли в грамотные предложения.
Техпис постоянно общается с разными людьми. С кем-то это легко и просто, а из кого-то информацию нужно добывать. Сложно представить на месте технического писателя интроверта, которого приводит в ужас мысль, что надо разговаривать.
Например, заказчик говорит, что ему нужна документация. У него есть макеты в «Фигме» и примерный флоу процесса. Выглядит так, будто для полноценной документации этого недостаточно.
Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст. Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно.
Марина Вашак, технический писатель Умение писать коротко и по делу.
Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями. Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано.
Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений. Обычно это списки из пар «Название поля — описание». Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна. Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет. Но, к сожалению, так бывает редко. Чаще нам встречаются объекты с непонятным названием и назначением.
Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз».
Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию. Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов. Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров». Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно.
Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя — писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно — он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать.
Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты. Даже если «этот снаружи» сидит в соседней команде. Любое погружение посторонних в проект или продукт уже подразумевает документацию, а, следовательно, и позицию технического писателя. Но у меня в практике был проект, когда документации нет и это не создаёт никаких реальных проблем. Вот тогда и писатель не нужен. Или к примеру, у меня в команде был такой разработчик, что он прекрасно пишет документацию и ему проще сделать это самому — вот такое у него хобби » Максим, директор департамента разработки ИТ-компании Какую карьеру может построить технический писатель? Технический писатель может выбрать для себя разные пути развития. Очень многое зависит от проекта, над которым работает технический писатель. Если брать сферу IT, ближе всего к техническому писателю профессия бизнес-аналитика.
Там требуются схожие качества: внимание к деталям, аналитический склад ума, стремление разложить все по полочкам. Из технического писателя получаются прекрасные специалисты по тестированию. Технический писатель может стать менеджером проектов, попробовать себя в тестировании. Если человек писал много документации о программах на Java, заинтересовался и решил изучить этот язык программирования, он может стать разработчиком. Некоторые технические писатели уходят в сферу маркетинга или продаж, особенное если это направление по продвижению IT-продуктов: умение структурировать информацию и наглядно представлять её помогает готовить презентации для потенциальных клиентов, а умение понимать нужды клиента или пользователя, предугадывать его вопросы, незаменимо в этой области. Многие технические писатели предпочитают работать на различных проектах: являясь фрилансерами, они вольны выбирать для себя наиболее интересные проекты, совершенствуя свои навыки в разных направлениях. Развиваясь, они становятся незаменимыми специалистами на биржах по поиску специалистов. Это интересно как самому техническому писателю, так и работодателю: специалист задействован на определенные задачи и трудовых отношений часто не возникает. Я всегда мечтала путешествовать, поэтому очень много время уделяла изучению иностранных языков.
Журналистика не пошла, хотя очень нравилось писать технические тексты. Знакомые предложили попробовать себя в IT — необходимо было разобраться с высокотехнологичным продуктом в помощь основному техническому писателю. Вот с этого началось мое погружение в IT. Несколько лет я работала в компании, пока наконец не поняла, что хотела бы совмещать мою любовь к путешествиям и любимую работу. Сейчас я фрилансер, заказы есть всегда, иногда даже привлекаю молодых специалистов к решению задач». Марина, технический писатель-фрилансер Заработная плата технических писателей. На июль 2021 года на известном ресурсе по поиску работы были найдены 335 вакансии по Москве и Московской области. С примером описания вакансии можно ознакомиться здесь. Средний размер заработной платы: от 100 000 до 150 000 рублей.
Если технический писатель принял решение работать как фрилансер, то ежемесячный уровень дохода примерно 150 000 — 200 000 рублей при наличии опыта от 3х лет. Первые заработки начинающих технических писателей начинаются от 5 000 — 10 000 рублей за проект. Заключение: В России профессия технический писатель является востребованной в основном на крупных проектах. Благодаря этим специалистам упрощается процесс коммуникаций и снижаются затраты на документацию и техническую поддержку. В ВУЗах России такой профессии не обучают и в нее можно попасть как имея техническое так и другое образование. Необходимо обладать определенным набором soft skills и активно совершенствовать профессиональные навыки. Спрос на технических писателей неуклонно растет и многократно превышает предложение: раньше технических писателей не было вообще, а теперь они нужны почти каждой IT-компании.
«День с писателем».
Теперь о вашем опыте и навыках, которые мы считаем ключевыми для вашей успешной работы. Требования: - Опыт подготовки технической документации ГОСТ 19, ГОСТ 34 ; - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию; - Уверенное владение пакетом офисных приложений Word, Excel ; - Базовое понимание процессов разработки программного обеспечения.
Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему. Пока сделать перерыв и пойти выпить кофе. С кофе главное правило — не увлекаться. Наливаю кофе и иду к обратно. Это мой первый обед, стараюсь делить прием пищи на два раза, так полезнее.
Очень вкусно.
Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено.
Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель. Профессии технического писателя в российских вузах не учат. Есть курсы, где можно научиться писать технические тексты, но их немного. Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других.
Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений. В отличие от копирайтинга, здесь меньше творчества и больше регламентов. Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли. Технический писатель должен сочетать в себе свойства технаря и гуманитария. Интерес к технике и программированию, усидчивость и внимательность должны в нём сочетаться с желанием осваивать новое и делиться своими знаниями. Очень важно знать предметную область, в которой ведется работа.
Например, если вакансия открыта в ИТ-компании, потребуется знать языки программирования и разбираться в процессах разработки софта. Список ПО зависит от отрасли, в которой трудится специалист. Нужно уметь работать в команде, общаться с разработчиками и понимать пользователей, которые будут использовать продукт. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями. В некоторых IT-компаниях требуется, чтобы технический писатель знал языки разметки текста или один из языков программирования на уровне чтения кода, другим важны навыки работы с базами данных или в системах управления запросами. То, что пригодится точно — интерес к той сфере, о которой технический писатель работает.
Некоторые работодатели требуют, чтобы образование у технического писателя было техническим. Другим нужно просто высшее образование. Еще одно требование — знание иностранного языка, потому лингвисты, филологи, переводчики тоже востребованы. Хорошо пишут тексты и коммуникабельны, как правило, выпускники гуманитарных направлений: литераторы, журналисты. Если человеку с таким образованием понравится разбираться в новой для себя области, то, скорее всего, ему подойдет эта профессия. Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков.
На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа технического писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Кому нужен технический писатель. Если проект небольшой, то возможно, технический писатель совсем не нужно.
Но есть огромные преимущества, когда в проекте есть технический писатель. Технические писатели четким языком излагаю информацию.
Наиболее экранизируемым писателям является Эдгар По. Сюжеты произведений этого американского писателя вошли в 114 кинофильмов. В Великобритании писательница Агата Кристи считается одним из символов страны и почитается наравне с королевой. Тираж ее произведений уступает только Шекспиру и Библии. О профессии писателя Писатели — люди, которые создают художественные литературные произведения разных жанров, предназначенные для широкой аудитории читателей. Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными. Писатели должны хорошо владеть языком и обладать индивидуальным стилем.
Люди, которые хотят посвятить себя писательству, учатся в ВУЗах на филологических и гуманитарных факультетах. Однако большинство писателей не имеют специального образования, а их профессии далеки от литературы.
День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
В Новом здании Российской национальной библиотеки (Московский пр., д.165 к.2) начала работу выставка «Затеси» Виктора Астафьева», приуроченная к 100-летнему юбилею русского писателя и драматурга. #Кем_стать: техническим писателем Много знать и доходчиво излагать свои мысли, уметь писать и одновременно разбираться в технике и технологиях, чтобы сложные вещи объяснить простым и понятным языком – работа технического писателя Работа эта стоит дорого. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования.
Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23
TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. #Кем_стать: техническим писателем Много знать и доходчиво излагать свои мысли, уметь писать и одновременно разбираться в технике и технологиях, чтобы сложные вещи объяснить простым и понятным языком – работа технического писателя Работа эта стоит дорого. Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. Всемирный день писателя отмечается не только литераторами, но и редакторами, корректорами, критиками, культурологами, журналистами и другими людьми, чья работа связана со словом. Самые свежие новости России и мира, новости политики, шоу-бизнеса.