Доклад Марии Макеевой на конференции AnalystDays #17 27-28 октября 2023. г. Москва Россия Опыт работы в аналогичной должности (или инженером – электроником) от одного года. девушка при исполнении, а в свободное время - поэт. Рассказываем о профессии технического писателя: обязанности, задачи, навыки, которые пригодятся для работы. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев.
Всемирный день писателя – 3 марта!
С 1984 года журнал поменял своё название на «Хроника наших дней» изменились заставка и музыка журнала. В ряде городов СССР, например, в Минске, были созданы специальные кинотеатры «Новости дня» для демонстрации выпусков одноименного киножурнала.
Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями». Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил.
В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются. Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки. Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления.
Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь». Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями.
Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано. Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений. Обычно это списки из пар «Название поля — описание». Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна. Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет.
Но, к сожалению, так бывает редко. Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок.
Вот такой стандартный набор. Первым делом проверяю рабочую почту, потом планирую фронт работ. Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге.
Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание.
Решения одобрены Минкомсвязи России и входят в единый реестр отечественного программного обеспечения. Помогает автоматизировать адаптацию стажеров, обучать сотрудников дистанционно, проводить онлайн-тестирование и сертификацию, измерять эффективность обучения в реальном времени iSpring Suite Простой и мощный конструктор онлайн-курсов, видеолекций, тестов и еще 20 типов материалов обучающего контента. Websoft Разработчик программного обеспечения для автоматизации HR-процессов WebTutor Комплексная система управления обучением, оценкой и развитием персонала CourseLab Инструмент разработки электронных курсов любой сложности Виртуальный класс Система для проведения веб-семинаров Включает в себя пользовательский портал для централизованного хранения созданных документов, быстрого обновления всех форматов документации, поддержания в актуальном состоянии и обучения пользователей ИТ-системам и бизнес-процессам, а также сбора соответствующей аналитики и оценки знаний и уровня цифровой адаптации пользователей. Решение упрощает обучение сотрудников ИТ-системам и сокращает трудозатраты экспертов по разработке и актуализации пользовательской документации. Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей.
Вакансия в архиве
- 366. День технической книги
- Вход в систему
- Похожие вакансии
- Новости дня — последние и главные новости в России и мире сегодня на РЕН ТВ
- Кто такой технический писатель и чем он занимается
Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля
- Зачем нужны технические писатели – информатика тесты
- День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
- С Днем технического писателя!
- Технический писатель
- Кто такой технический писатель и чем он занимается
- Кто читает инструкции?
Лента новостей
Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. Полчаса смеялся, когда некая hbnf назначила (в философтовском форуме) 1 апреля Днем технического писателя. Поэтому какое-то время мечтала стать писателем. Поэтому какое-то время мечтала стать писателем. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. Главная задача технического писателя – четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть.
Кто такие технические писатели и зачем они нужны в команде
Поскольку, по нашему опыту, мероприятие посещают не все зарегистрировавшиеся участники, мы примем больше заявок — в качестве эксперимента мы остановим регистрацию на 50 участниках. Возможно, что вы зарегистрируетесь, но не попадёте на вебинар. Просим правильно понять этот момент и дождаться записи, которую мы обязательно выложим на сайте, а общение можно будет продолжить в комментариях на сайте и в соцсетях. Присоединяйтесь к нам всей компанией, но по возможности с одного компьютера, чтобы оставить больше свободных мест! Первый сбор На первый Доквариум мы приглашаем вас в четверг 28 июля, в 16:00 по московскому времени.
Ориентировочно мероприятие займёт 2 часа. Тема: «Инструменты технического писателя». Анастасия подготовила доклад «Создаём документацию с удовольствием в MadCap Flare», в котором она поделится своим многолетним опытом работы в MadCap Flare, а вы сможете задать ей любые вопросы. Кстати, недавно в нашем блоге была статья Анастасии на эту тему.
Далее технический директор компании «ПроТекст» Валерий Ледовской расскажет о средствах нашей работы: «Инструменты компании ПроТекст при выполнении задач технического перевода и локализации на аутсорсинге». Затем нам хотелось бы послушать рассказы самих участников об использовании разных инструментов, кроме самого распространённого варианта — Microsoft Word.
Клиент SuperJob с 2021 годаБолее 100 сотрудников Деятельность в сфере гидрометеорологии и мониторинга окружающей среды. Вакансия перемещена в архив Вероятно, эта вакансия закрыта. Но у нас есть много других похожих вакансий, которые могут Вас заинтересовать.
С кофе главное правило — не увлекаться. Наливаю кофе и иду к обратно. Это мой первый обед, стараюсь делить прием пищи на два раза, так полезнее. Очень вкусно.
Я снова за ноутом. После обеда, даже такого легкого, появилось желание поспать. Нихт, арбайтен, архитектура сама себя не опишет. Хочу помощи зала. Пишу, рисую, разбираю рулбуки. Второй великий обеденный поход.
Требования: - Опыт подготовки технической документации ГОСТ 19, ГОСТ 34 ; - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию; - Уверенное владение пакетом офисных приложений Word, Excel ; - Базовое понимание процессов разработки программного обеспечения.
Контактные телефоны:.
TECHWRITER DAYS
Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov. Кастинг, вакансия для ДРУГОЕ: (Удаленка) Требуется технический писатель. Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех». Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева.
Яндекс Образование
Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. Мы ищем технического писателя в команду Indeed Access Manager. Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации.
«День с писателем».
С целью напоминания о роли писательства в мире был учреждён Всемирный День писателя, который отмечается ежегодно 3 марта. Мы ищем технического писателя в команду Indeed Access Manager. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. SQA ANALYST TECHWRITER DAYSСмотреть онлайн - Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей.
Вы можете заказать манипуляторы следующих моделей
- Выставка к 100-летию писателя Виктора Астафьева
- Зачем нужны техписатели?
- Навигация по записям
- Текст как призвание
ВДНХ и городские библиотеки приглашают 3 марта на День писателя
Конференция нацелена на объединение специалистов по документации для обмена опытом, укрепления профессиональных связей, приобретения новых навыков, вдохновения и приятного времяпрепровождения. Дополнительную информацию можно получить на сайте конференции. Когда и где: 14 — 16 апреля, Портленд, США. Это событие соберет вместе профессионалов различных направлений в индустрии разработки: backend, frontend и fullstack-разработчиков, тестировщиков и QA-специалистов, web-дизайнеров и проектировщиков интерфейсов, системных аналитиков, тимлидов, техлидов и менеджеров разработки. Участникам будет предоставлена возможность рассказать о своей компании, продуктах и новых проектах. Техническим писателям также будет интересно присоединиться! Когда и где: 26 апреля, Екатеринбург, РФ. Будучи самой старой организацией в данной области, STC предоставляет широкие возможности для общения и обучения у коллег, интенсивные сессии по ключевым темам и обновлениям в отрасли. Это мероприятие способствует постоянному развитию знаний, навыков и общения для профессионалов в области технической коммуникации. Более подробную информацию о программе саммита можно найти на сайте STC. Когда и где: 17-19 мая, Миннеаполис, США.
Июнь Каждый год специалисты по технической коммуникации, включая разработчиков информации, технических писателей, технических редакторов и переводчиков, собираются на мероприятии Evolution of TC, которое фокусируется на новых разработках в области документации программного обеспечения. Данное мероприятие является единственной техкомм конференцией в Юго-Восточной Европе. Для получения более подробной информации обращайтесь на сайт конференции. Когда и где: 4-5 июня, София, Болгария.
Вот такой стандартный набор. Первым делом проверяю рабочую почту, потом планирую фронт работ.
Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге. Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance.
Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание.
Текстильщики в шаговой доступности от метро Выходной день в честь дня рождения.
Технический проект — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца.
Только так получится хорошая и качественная документация. Процесс работы технического писателя. Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство.
На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов. Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану.
Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель. Профессии технического писателя в российских вузах не учат.
Один день из жизни технического писателя. Среда.
| : техническим писателем ✒ | В Новом здании Российской национальной библиотеки (Московский пр., д.165 к.2) начала работу выставка «Затеси» Виктора Астафьева», приуроченная к 100-летнему юбилею русского писателя и драматурга. |
| Газета.Ру в соцсетях | Роль технического писателя Технический писатель переводит «от разработчика – клиенту». |
Один день из жизни технического писателя. Среда.
Дневник писателя Ф. М. Достоевского. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. На сайте в рубрике «Наука и техника» всегда свежие новости за день и неделю.
: техническим писателем ✒
| День писателя | День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. |
| Кто такой технический писатель и чем он занимается | Умение создавать, редактировать, иллюстрировать и адаптировать технический материал, способность разбираться в незнакомых областях. |
| Военная операция на Украине | Главная задача технического писателя – четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть. |
НОВОСТИ ДНЯ
Технический день в модельной библиотеке им. Салтыкова-Щедрина перенесен на 22 февраля 17 февраля 2022 Уважаемые читатели! В феврале в модельной библиотеке им.
Хочу помощи зала. Пишу, рисую, разбираю рулбуки. Второй великий обеденный поход. По правде говоря, было очень средне, обычно готовят намного вкуснее. Десять минут на обед, надо подготовиться к стендапу.
К стендапу надо отчитаться о проделанной работе, и что планирую сделать на сегодня. Командой обсуждаем наработки. На всё про всё минут 15, продуктивно и не затратно. Планов у команды много, идей еще больше. Это хорошо, под такие задумки мне стыдно выдавать слабый материал.
Это мероприятие способствует постоянному развитию знаний, навыков и общения для профессионалов в области технической коммуникации. Более подробную информацию о программе саммита можно найти на сайте STC.
Когда и где: 17-19 мая, Миннеаполис, США. Июнь Каждый год специалисты по технической коммуникации, включая разработчиков информации, технических писателей, технических редакторов и переводчиков, собираются на мероприятии Evolution of TC, которое фокусируется на новых разработках в области документации программного обеспечения. Данное мероприятие является единственной техкомм конференцией в Юго-Восточной Европе. Для получения более подробной информации обращайтесь на сайт конференции. Когда и где: 4-5 июня, София, Болгария. Knowledge Conf 2024 Программа конференции Knowledge Conf охватывает широкий спектр аспектов управления знаниями. В ее рамках рассматриваются как прикладные задачи, включающие в себя обучение новичков, организацию базы знаний, создание внутренних университетов, а также практическое обучение, так и фундаментальные аспекты, такие как применение современных методов обучения и развитие системного мышления.
Мероприятие позиционируется как профессиональная конференция по управлению знаниями и ее программа отражает этот слоган. Когда и где: 27-28 июня, Санкт-Петербург, РФ. Целью конференции является распространение существующих и создание новых знаний об архитектуре программных решений. Несмотря на то, что данное мероприятие не ориентировано на технических писателей, некоторые темы докладов могут быть интересны и им. Конференция также будет проводиться онлайн, что позволит участвовать в ней без необходимости поездок. Когда и где: 1 ноября, Москва, РФ.
Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе.
Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику. На поверку становись! Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики. Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации. Ещё наши документы проверяет наш профессиональный технический редактор.
Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы. Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД.
Есть руководства пользователя с подробным описанием каждой кнопки интерфейса. Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке. Но в любом случае писатель должен быть внимательным, аккуратным и педантичным. Клиент всегда прав — отгрузка до 23.
Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу. Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены. Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы. Большие надежды — портал bercut. К примеру, поиск нужной информации можно выполнять только в рамках одного PDF-файла.
Нельзя поискать описание какого-то параметра сразу во всей документации по системе. Это очень неудобно, ведь количество документов на одну систему часто исчисляется десятками. Если не знать, в каком документе искать нужные данные, то поиск превращается в нетривиальную задачу.
Февральская встреча Сообщества технических писателей Санкт-Петербурга
| КАЗАНСКИЙ НАЦИОНАЛЬНЫЙ ИССЛЕДОВАТЕЛЬСКИЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ ИМ. А. Н. ТУПОЛЕВА - КАИ | за профессионализм, признание професии и чистоту русского языка (и в технических документах тоже)! |
| Яндекс Образование | Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. |
| Конференция TechWriter Days 05.04.2024 - 06.04.2024 | Киножурнал "Новости дня" выходил с 1944 по 1983 годы. |
| День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽ | Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023! |