5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей – TechWriter Days.
About the Conference
- Про плагиат
- Рекомендации
- Вакансия в архиве
- Один день из жизни технического писателя. Среда. | Станислав Андронов | Дзен
- 5 июля 2023 года - 120 лет со дня рождения писателя Владимира Григорьевича Сутеева
Один день из жизни технического писателя. Среда.
Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. День технического перевода. Степан ЖуринГазета «Лицейский вестник» и «Лицейское телевидение»15 октября 2019. В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября.
Главные новости
- Всемирный день писателя | Отрадненский нефтяной техникум
- «День с писателем». |
- Новости в России и мире - ТАСС
- Подпишитесь на рассылку
Зачем нужны технические писатели
В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером. Опыт работы в аналогичной должности (или инженером – электроником) от одного года. 21 апреля в ГУНБ в отделе технической литературы (3 этаж, каб. 301) пройдет День технической книги.
(Удаленка) Требуется технический писатель.
Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023! Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно. 5-6 апреля в Москве состоится 1-я Международная конференция технических писателей TechWriter Days. Во Всемирный день писателя вручаются награды и премии проявившим себя литературным деятелям. Мы ищем технического писателя в команду Indeed Access Manager.
Оклад: 25000-30000 руб.
З марта отмечается Всемирный день писателя03.03.2022 18:33 — ННТВ (видео). Дневник писателя Ф. М. Достоевского. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте.
Кто такие технические писатели и зачем они нужны в команде
Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно. Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру. Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям.
Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются. Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель. У разработчиков есть код-ревью. У технических писателей, если их больше одного, в идеальном мире есть ревью текстов.
Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной. И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай». Как понять, что работа мне подходит Возьмите приложение любимого банка и напишите инструкцию к какому-то простому процессу. Например, как оплатить мобильную связь. Покажите эту инструкцию друзьям или родителям, попросите проверить и попробовать пополнить баланс, следуя ей. Если инструкция сработала — поздравляю, это прекрасный старт, вы готовы к тестовым заданиям.
Помониторьте вакансии для технических писателей без опыта и запросите тестовое задание. Вас попросят описать реальный кейс или подготовить простую инструкцию к бытовым действиям или вещам. Однажды мне дали задание: написать инструкцию к кошке. Пожалуй, это было самое милое тестовое. Я описывала кошку как самораспаковывающуюся систему. Подготовить платформу для установки и выбрать источник нужно заранее.
Благодаря таким бытовым инструкциям можно оценить, как мыслит и пишет кандидат. А тестовые по реальным кейсам дадут представление о его умении разбираться в непонятных терминах и находить информацию. Марина Вашак, технический писатель Далеко не все компании дают обратную связь.
Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге. Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance.
Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему. Пока сделать перерыв и пойти выпить кофе.
Также напоминаем, что 23 февраля библиотека не работает в связи с официальным праздником — Днем защитника Отечества. В остальные дни февраля будем рады видеть читателей согласно нашему привычному графику работы.
Помогает автоматизировать адаптацию стажеров, обучать сотрудников дистанционно, проводить онлайн-тестирование и сертификацию, измерять эффективность обучения в реальном времени iSpring Suite Простой и мощный конструктор онлайн-курсов, видеолекций, тестов и еще 20 типов материалов обучающего контента. Websoft Разработчик программного обеспечения для автоматизации HR-процессов WebTutor Комплексная система управления обучением, оценкой и развитием персонала CourseLab Инструмент разработки электронных курсов любой сложности Виртуальный класс Система для проведения веб-семинаров Включает в себя пользовательский портал для централизованного хранения созданных документов, быстрого обновления всех форматов документации, поддержания в актуальном состоянии и обучения пользователей ИТ-системам и бизнес-процессам, а также сбора соответствующей аналитики и оценки знаний и уровня цифровой адаптации пользователей. Решение упрощает обучение сотрудников ИТ-системам и сокращает трудозатраты экспертов по разработке и актуализации пользовательской документации. Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей. UnaDesk Специализированное программное обеспечение для автоматизированного создания сценариев работы пользователей в ИТ-системах и, на базе этих сценариев, создания учебных материалов, симуляций и документации для пользователей различных ИТ-систем, что позволяет сопровождать пользователя по всем шагам, необходимым для выполнения бизнес-процесса в ИТ-системах Подробнее Российский разработчик системы для быстрого освоения корпоративного ПО HintEd Платформа интерактивного обучения работе в корпоративном ПО.
Лента новостей
Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC.
Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана.
В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП.
На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент. Есть ещё один важный источник — описание настроек интеграционного тестирования.
Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении.
Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано.
Покупаю билет на электричку: 20. Смотрю расписание, а сзади меня уже крадется поезд: 21. Из окна можно лицезреть разные виды граффити - пошлые и не очень, красивые и страшные, милые и жуткие и много других. Однажды появился новый рисунок, я ехала грустная и злая, но увидела его и сразу разулыбалась. Интересных граффити больше нет, можно почитать. Некоторое время назад решила перечитать всего Достоевского, очень развивает Жаль, что заграницей этого писателя любят намного больше, чем у нас в России. Я не буду показывать и описывать свой день в офисе, он не отличается чем-то интересным. Я сижу весь день уткнувшись в PHP-код, часто с угрюмым лицом, иногда среди тишины раздаются мои возгласы или возгласы программиста.
Изредка смех технической поддержки и ооооооочень редко ворчание начальника. Конец рабочего дня официально в 7 вечера, но голова пухнет от компьютера и программного кода, меня ждет друг и я сбегаю из офиса. Время: 25. Мы встретились и решили пойти в Парк Горького, я давно не была и мне все рассказывали, как здорово там сейчас сделали. А еще я сначала совсем забыла, что нужно фотографировать всё вокруг и вспомнила только на милых уточках: 26. Этой мой друг. Друга зовут Максим. Мы хотели покататься на лодках, но там была огромная очередь! Тогда мы решили пойти на набережную и разузнать, как ходят речные трамвайчики.
А еще гостям покажут уникальный памятник русской литературы XVII века — «Житие протопопа Аввакума, им самим написанное». Протопоп Аввакум положил начало такому жанру, как автобиография. Например, гости узнают, как возникло русское стихосложение и почему Александр Пушкин до сих пор считается главным русским поэтом. Посещение экскурсии и музея бесплатное. Любители русской литературы 3 марта могут посетить выставку «Лев Толстой. Гости ВДНХ пог рузятся в атмосферу первой половины XIX века и в интерактивном формате познакомятся с творчеством великого русского писателя. Экспозиция состоит из 13 тематических разделов. Каждый из них посвящен определенному эпизоду романа-эпопеи «Война и мир». При помощи мультимедийных технологий посетители смогут разучить танцевальные движения, повторяя их за парой на экране, или поиграть в старые карточные игры, а после этого проследить за ходом Бородинского сражения.
В павильоне открыто арт-пространство, где можно посмотреть фильмы о жизни и творчестве Льва Толстого, а также принять участие в литературном вечере и даже создать мультфильм по мотивам произведения. Вход на постоянную выставку свободный. Она работает с 11:00 до 19:00 ежедневно, кроме понедельника. Великий поэт в культуре Азербайджана». Она посвящена 210-летию со дня рождения классика русской литературы, которое отметят в этом году 15 октября. Поэт неоднократно посещал азербайджанские земли, изучал азербайджанский язык, общался с местной интеллигенцией. К тому же он дружил с известным азербайджанским писателем, философом и общественным деятелем Мирзой Фатали Ахундовым. В экспозиции представлены интерьеры литературного салона времен первой половины XIX века, а также произведения скульптора Алекс андра Бурганова, пос вященные поэту.
Будут ли пользователи читать сопроводительную документацию на сайте? Как организовать пополнение FAQ?
Почему техрайтер должен участвовать в создании онбординга? Где техписателю найти информацию о разработке для iOS и Android? Рекомендуем посмотреть ссылки в заметке Что почитать о разработке документации для мобильных приложений , чтобы с большей пользой провести обсуждение новой темы.