Сталин и писатели. Должность: технический писатель, хотя в последнее время скорее knowledge manager. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов.
Оклад: 25000-30000 руб.
| Оклад: 25000-30000 руб. | Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия |
| Новости дня – «ВЗГЛЯД.РУ» | В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником. |
| С Днем технического писателя!: natabusinka — LiveJournal | Опыт работы в должности бизнес-аналитика или технического писателя от 1 года. |
: техническим писателем ✒
В общем, текстов хватает. Так зачем же тогда в самом конце разработки нужен ещё и технический писатель? Почему всех этих документов недостаточно для того, чтобы дать ответы на основные вопросы заказчика и пользователя: как работает система и как её настроить? Будем разбираться. Разработчики должны писать код, а не текст «Условие, что поле PART должно быть не пустым, обеспечивается целостностью процесса, заполняющего это поле, и не обеспечивается отдельным ограничением Oracle типа NOT NULL для обеспечения максимального быстродействия при изменении данных таблицы». Из внутренней документации проекта Бывает так, что программисты прекрасно разбираются в программе, досконально понимают все тонкости работы системы, но не могут красиво изложить всё это в текстовом виде. Лично я убеждён, что в этом нет ничего плохого. Согласитесь, что даже текст, написанный с орфографическими и стилистическими ошибками, может быть понятным и успешно выполнять свою функцию — доносить до читателя мысль автора. А ошибки — это дело поправимое, коррекцию и правку текста при необходимости может выполнить редактор или тот же технический писатель. Главное — не допускать ошибок фактических. Каждый должен заниматься своим делом.
Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон. Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей. Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы. Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями». Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил. В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются.
Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки. Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления.
Познакомились с книгой и посмотрели мультфильм о приключениях необыкновенной собачки Сони, которая очень любит думать. Юные участники мероприятия с удовольствием отгадывали загадки, внимательно слушали стихи и песни в исполнении самого Андрея Усачёва и сами рассказывали его стихи. После мероприятия ребята с интересом рассматривали книги, принесённые библиотекарем.
Project managers can learn how to organize and optimize the processes of creating and managing technical documentation to improve project quality. Product Managers. Product managers can gain insight into how effective technical documentation can improve customer and user perception of the product. Suppliers of Tools and Technologies. Companies that provide tools and technologies for creating and managing technical documentation can use the conference to promote their products and connect with potential customers. Why should I participate? Communication Two days of intensive work with colleagues, you will be able to discover new solutions to the challenges facing you and your company. Experience You can familiarize yourself with best practices and personally discuss the details that interest you with independent experts and representatives of leading IT companies. Networking Informal interactions will provide you with information about the effectiveness and feasibility of specific solutions your company plans to use. Discussions Participating in roundtable discussions and debates will enable you to view aspects of technical documentation from different perspectives, uncovering new possibilities for effective work. Contacts New connections will help you tap into the vast experience of top experts in the field of technical documentation. Learning A unique opportunity for learning and participation in workshops will allow you to enhance the quality of your work.
Мы гарантируем подачу техники на объект в течение 30 минут. В нашем автопарке представлена манипуляторы от лучших производителей: Hyundai КАМАЗ Mercedes Вся техника находится в полностью исправном состоянии, подготовлена к выполнению нужной задачи и заправлена. Операторы КМУ — опытные водители с подходящей для работы квалификацией. Сделать расчет аренды манипулятора можно онлайн или оставив заявку на сайте. Менеджер принимает заказы круглосуточно, поэтому мы свяжемся с вами в течение 5 минут.
Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. «Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. Главной целью для технического писателя является объяснить пользователю, как обращаться с приборами или компьютерными программами доступным и понятным языком. Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023!
Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23
Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями. Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано. Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений. Обычно это списки из пар «Название поля — описание». Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна. Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет.
Но, к сожалению, так бывает редко. Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением. Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя. Изъян привёл к конфузу Решили, что «баг» — это «изъян», а «инцидент» — «конфуз». Думаю, излишне говорить, что для достижения нормального взаимодействия между всеми участниками процесса разработки, они должны использовать единую терминологию.
Если же терминология размыта, один и тот же объект может называться по-разному, то договориться будет очень сложно. Для того, чтобы достичь единства в этом вопросе, в компании должен существовать единый глоссарий терминов. Простой пример: один и тот же объект во внутренних документах может называться «системным параметром», «параметром системы», просто «параметром» или даже «записью в таблице параметров». Для разработчиков системы может быть понятно, что всё это — один и тот же объект. Для пользователя же это совсем не так очевидно.
Уверенное владение офисным пакетом Microsoft Office работа со стилями, многоуровневыми списками, перекрестными ссылками и т. Текстильщики в шаговой доступности от метро Выходной день в честь дня рождения.
Итак, зачем же всё-таки техническим писателям посещать конференции? Ниже приведены основные преимущества: Общение. Одним из ключевых преимуществ конференций для технических писателей является возможность встретиться с коллегами из индустрии. Это не только позволяет обсудить актуальные тенденции и вызовы в области технического писательства, но и обменяться опытом и лучшими практиками. Встречи с единомышленниками могут стимулировать новые идеи и подходы к работе. Обучение и развитие навыков. Конференции для технических писателей предлагают широкий спектр сессий, покрывающих различные аспекты профессии. От основных принципов технического писательства до новейших инструментов и технологий, используемых в отрасли. Участие в таких мероприятиях помогает техписам расширить свой арсенал навыков и оставаться в курсе последних тенденций в области. Практические знания и исследования. Конференции часто включают в себя практические сессии, мастер-классы и демонстрации продуктов, которые позволяют техническим писателям углубиться в конкретные аспекты своей работы. Это может быть рассмотрение конкретных кейсов использования, анализ современных тенденций в дизайне документации или изучение специализированных инструментов для улучшения процессов написания и публикации. Вдохновение и мотивация. Встречи с успешными профессионалами и истории их успеха могут дать новый импульс для развития собственной карьеры. Помимо этого, присутствие на конференции создает ощущение принадлежности к сообществу, где каждый участник чувствует себя важным звеном в общей цепи.
Выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева С приветственным словом выступила первый заместитель директора РГДБ Анжела Лебедева: Сегодня мы открываем выставку работ иллюстраторов замечательного писателя, человека героической судьбы Анатолия Васильевича Митяева. Я всех поздравляю с открытием: очень символично, что оно проходит накануне великого праздника Победы и в честь дня рождения писателя. Анжела Лебедева Художник-иллюстратор, доцент кафедры «Иллюстрация и эстамп» Института графики и искусства книги имени В. Фаворского Московского Политеха Ольга Монина поделилась воспоминаниями из детства об Анатолии Митяеве: Мои детские и юношеские воспоминания о Митяеве укладываются в слово «улыбка». Он действительно улыбался везде, в том числе и на рабочем месте — в редакции журнала «Мурзилка». Для меня самый тёплый «Мурзилка» — это именно митяевский «Мурзилка». Анжела Лебедева и Ольга Монина Режиссёр-мультипликатор Леонид Носарев отметил вклад Анатолия Митяева в детскую литературу: В некотором смысле Анатолий Митяев определил мою творческую судьбу: благодаря ему в моей жизни произошли судьбоносные встречи, в том числе с замечательным писателем Юрием Ковалём.
НОВОСТИ ДНЯ
Рассказываем о профессии технического писателя: обязанности, задачи, навыки, которые пригодятся для работы. Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов. В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником. Известный нижегородский писатель Валерий Шамшурин так сказал о нем. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. Опыт работы в должности бизнес-аналитика или технического писателя от 1 года.
День технического писателя
| (Удаленка) Требуется технический писатель. | Опыт работы в должности бизнес-аналитика или технического писателя от 1 года. |
| Новости | Центральная Библиотечная Система (ЦБС) | 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. |
| Технический писатель | Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. |
| «День с писателем». | Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. |
TECHWRITER DAYS
Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. Опыт подготовки технической документации (ГОСТ 19, ГОСТ 34); - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию. О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником. Главная задача технического писателя – четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть.
#Кем стать: Техническим писателем
С РП технический писатель взаимодействует для координации и контроля над соблюдением всех необходимых формальностей со стороны участников проекта. Обеспечивает консистентность формальной части проекта. Цели работы технического писателя Работа в сфере заказной разработки — это командный вид спорта, поэтому цель работы технического писателя — это успех всей команды, всего проекта. Антицель — написать красивый документ по ГОСТу, по которому невозможно провести испытания демонстрацию продукта заказчику , либо который не коррелируется с разработанной функциональностью продукта.
Поэтому технический писатель разрабатывает документацию для целей, которые должны совпадать с целями компании. Если он пишет отчетную документацию по конкретному проекту, то он должен тесно взаимодействовать с проектной командой и осознавать, что разработанная функциональность будет приниматься заказчиком именно на основе написанной им отчетной документации. А ошибки в отчетной документации приводят к провалу испытаний или вовсе к отказу в приемке работ.
Для технического писателя важно не зацикливаться на самом тексте, а смотреть в суть. Прийти к разработчику и спросить: «Все ли я правильно понял и написал? Еще один важный момент — технический писатель должен не только предоставить заказчику комплект отчетной документации, но и согласовать ее с ним.
Если клиенту что-то не нравится — выяснить, что именно, и понять, как это исправить. Куда расти техническому писателю Представим ситуацию, что человек приходит на позицию технического писателя, перерастает грейд Junior и в какой-то момент начинает думать: «А куда дальше развиваться? Буду ли я до конца карьеры писать технические документы, такие как руководство пользователя?
У технического писателя есть конкретные зоны роста — как горизонтального, так и вертикального. Поговорим о горизонтальном росте подробнее. Хороший технический писатель должен знать, какие шаги нужно пройти для успешной сдачи проекта.
Это шаги, которые находятся не только в его компетенции, но и которые должны пройти другие участники команды: дизайнеры — нарисовать макеты, разработчики — написать код, аналитики — описать бизнес-процессы. И контроль выполнения работ другими участниками команды тоже может быть в числе обязанностей техписа. Также техпис должен уметь оценивать затраты на разработку той или иной документации: Сначала сформулировать требования к другим участникам команды — в каком виде и в какие сроки ему должны предоставить исходные данные для формирования комплекта отчетной документации.
С учетом качества и количества исходных данных прикинуть свои трудозатраты на формирование отчетной документации. Уложить это все на план-график исполнения контракта, понять, сколько нужно людей, какой трек согласования документации, и как вообще при этом выжить. То есть это процессное и ресурсное управление, которым он должен владеть.
И это схожие процессы с теми, которые есть у руководителя проекта. Что из этого следует: техпис может быть правой или левой рукой руководителя проекта и, соответственно, в этом направлении развиваться. Так что хороший техпис может вырасти до РП.
Иногда это классическая аналитика при ведении проектов, когда сначала есть общие верхнеуровневые требования, а затем надо проговорить с заказчиком, что сделать — декомпозировать эти требования, провести трассировку, управлять ими. Бывают и неклассические аспекты аналитики. Например, мы берем проект, которым ранее занимался другой подрядчик.
И теперь нам надо его развивать. Стартовая задача технического писателя — это разобраться в этом проекте, провести Reverse engineering технической части проекта: что написано, как это работает. Вторая задача — посмотреть на документы, какие были договоры и технические задания.
И понять, что реально представляет собой проект или конкретный продукт, и соотнести с тем, что написано в документах.
Разработчики должны писать код, а не текст «Условие, что поле PART должно быть не пустым, обеспечивается целостностью процесса, заполняющего это поле, и не обеспечивается отдельным ограничением Oracle типа NOT NULL для обеспечения максимального быстродействия при изменении данных таблицы». Из внутренней документации проекта Бывает так, что программисты прекрасно разбираются в программе, досконально понимают все тонкости работы системы, но не могут красиво изложить всё это в текстовом виде. Лично я убеждён, что в этом нет ничего плохого. Согласитесь, что даже текст, написанный с орфографическими и стилистическими ошибками, может быть понятным и успешно выполнять свою функцию — доносить до читателя мысль автора. А ошибки — это дело поправимое, коррекцию и правку текста при необходимости может выполнить редактор или тот же технический писатель. Главное — не допускать ошибок фактических.
Каждый должен заниматься своим делом. Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон. Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей. Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы. Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время.
Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями». Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил. В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются. Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки.
Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления. Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь». Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком.
Предварительно назовем точную стоимость, пропишем ее в договоре — вам не придется ничего доплачивать в процессе или после выполнения работ. Для постоянных клиентов всегда действует специальная скидка. При аренде крана-манипулятора вам не придется покупать технику под разные работы, и вы сможете максимально сэкономить. Это лучшее решение, если нужны грузоперевозки крупногабаритных грузов, погрузка и разгрузка, подъем на высоту.
На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Процесс работы технического писателя. Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов. Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель. Профессии технического писателя в российских вузах не учат. Есть курсы, где можно научиться писать технические тексты, но их немного. Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других.