З марта отмечается Всемирный день писателя03.03.2022 18:33 — ННТВ (видео). Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля.
Наука и техника
Роль технического писателя Технический писатель переводит «от разработчика – клиенту». Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. С целью напоминания о роли писательства в мире был учреждён Всемирный День писателя, который отмечается ежегодно 3 марта. Жителей Молдавии призвали праздновать День Европы вместо Дня Победы. Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий. Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации.
: техническим писателем ✒
Решения одобрены Минкомсвязи России и входят в единый реестр отечественного программного обеспечения. Помогает автоматизировать адаптацию стажеров, обучать сотрудников дистанционно, проводить онлайн-тестирование и сертификацию, измерять эффективность обучения в реальном времени iSpring Suite Простой и мощный конструктор онлайн-курсов, видеолекций, тестов и еще 20 типов материалов обучающего контента. Websoft Разработчик программного обеспечения для автоматизации HR-процессов WebTutor Комплексная система управления обучением, оценкой и развитием персонала CourseLab Инструмент разработки электронных курсов любой сложности Виртуальный класс Система для проведения веб-семинаров Включает в себя пользовательский портал для централизованного хранения созданных документов, быстрого обновления всех форматов документации, поддержания в актуальном состоянии и обучения пользователей ИТ-системам и бизнес-процессам, а также сбора соответствующей аналитики и оценки знаний и уровня цифровой адаптации пользователей. Решение упрощает обучение сотрудников ИТ-системам и сокращает трудозатраты экспертов по разработке и актуализации пользовательской документации. Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей.
Технический проект — это закон для разработчиков, тестировщиков и технических писателей.
В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Есть ещё один важный источник — описание настроек интеграционного тестирования.
Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Процесс работы технического писателя.
Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком.
Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту.
Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов. Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться.
Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель.
Профессии технического писателя в российских вузах не учат.
Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров.
А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов.
После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу.
Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много.
Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент. Есть ещё один важный источник — описание настроек интеграционного тестирования.
Название клуба образовалось от первых букв английских слов Poets — поэты, Essayists — очеркисты и Novelists — романисты. Традиции праздника Во Всемирный день писателя вручаются награды и премии проявившим себя литературным деятелям. В библиотеках, национальных ПЕН-центрах и литературных музеях устраиваются книжные выставки и презентации новых художественных произведений, организуются творческие встречи с авторами. В школах уроки литературы посвящаются известным классикам. Интересные факты Русский ПЕН-центр возник в 1989 году. Его штаб-квартира находится в Москве. Президент РФ В.
Путин объявил 2015-й год в России Годом литературы. Первым лауреатом Нобелевской премии по литературе стал в 1901 году французский поэт и эссеист Сюлли-Прюдом.
366. День технической книги
Нужно обязательно знакомить детей с произведениями Анатолия Митяева, они хрестоматийные. Леонид Носарев На открытии выставки выступила Татьяна Окружная, директор Рязанской областной детской библиотеки. Она представила сборник «Сказки у костра», переизданный к столетию А. Митяева: Я приехала, чтобы передать вам привет из родных мест Анатолия Васильевича, из Рязанской области: он родился в посёлке Ястребки Сапожковского района. Анатолий Васильевич очень любил свою родину, приезжал несколько раз к нам в Рязань, видел свою школу, в которой учился. А мы, рязанцы, любим и помним Митяева, и как можем, сохраняем память о нем. В прошлом году, накануне столетия, благодаря Ие Николаевне Пестовой мы переиздали его «Сказки у костра».
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. Change of Environment Working in a new setting will enable you to look at technical documentation development issues in a fresh light and make the most efficient use of your time for company development. WiFi High-speed internet will allow you to perform real-time production tasks, even while attending presentations. For your convenience, a template letter for your management justifying your participation in the conference is provided below. Gaining New Knowledge and Best Practices. The conference provides access to current trends, innovative tools, and best practices in the field of technical documentation. Companies can learn about new methods of documentation creation and implement them into their processes. Employee Training.
Participation of company employees in the conference serves as a form of continuous learning. Employees can enhance their knowledge and skills, which, in turn, can improve the quality and efficiency of technical documentation creation.
По итогам 2018 г. Уверенное владение офисным пакетом Microsoft Office работа со стилями, многоуровневыми списками, перекрестными ссылками и т.
Читаешь, что-то какие то запятые там исправляешь, меняешь абзацы какие-то и вот когда туда уже полностью входишь, вдруг начинает вырисовываться что же будет дальше». Первые тексты, вспоминает Олег Рябов, писал на чистом энтузиазме. Сейчас он уверен - писательство — занятие для личности зрелой, уже нажившей определенный опыт. В своих книгах и стихах Олег выделяет несколько основных тем, но главная — тема Родины.
А родина Олега Рябова — Нижний Новгород.
НОВОСТИ ДНЯ
В Новом здании Российской национальной библиотеки (Московский пр., д.165 к.2) начала работу выставка «Затеси» Виктора Астафьева», приуроченная к 100-летнему юбилею русского писателя и драматурга. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна.
Один день из жизни технического писателя. Среда.
Наконец, я у работы. Внутри ждет вкусный завтрак и работа. Сразу иду в столовую, чтобы не терять время. Манная каша, пудинг и черный чай с молоком.
Вот такой стандартный набор. Первым делом проверяю рабочую почту, потом планирую фронт работ. Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге.
Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта.
Здесь вы отыщете наиболее значимые происшествия, новости Санкт-Петербурга, последние новости бизнеса, а также события в обществе, культуре, искусстве. Политика и власть, бизнес и недвижимость, дороги и автомобили, финансы и работа, город и развлечения — вот только некоторые из тем, которые освещает ведущее петербургское сетевое общественно-политическое издание.
Роман опубликовали в начале 1940-х годов, это стало началом 60-летней писательской карьеры. Он выпустил 13 романов в цикле «Георгий Седов», большинство из них были написаны в 50-е годы. Написал «Арктический мост», «Фаэты», «Тайна нуля», «Острее шпаги», «Клокочущая пустота» и многие другие книги. Его последний роман «Звезда Нострадамуса» вышел в 2000-м, а в 2001-м в соавторстве с сыном он написал фантастико-автобиографический роман «Фантаст». Несмотря на обширную библиографию, прозу Александра Казанцева экранизировали лишь однажды. Ведущий советский разработчик методов комбинированных съемок Павел Клушанцев снял фильм «Планета бурь» 1961 по одноименной повести, в которой герои отправляются на Венеру.
Выходили и специальные выпуски, посвященные очередному съезду КПСС, выборам, праздничным датам, торжественным похоронам видных государственных и политических деятелей. С 1984 года журнал поменял своё название на «Хроника наших дней» изменились заставка и музыка журнала. В ряде городов СССР, например, в Минске, были созданы специальные кинотеатры «Новости дня» для демонстрации выпусков одноименного киножурнала.
Один день технического писателя
Поздравляем всех технических писателей страны с профессиональным праздником и желаем нескучных рабочих будней, отличного настроения и благодарных пользователей! Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Служба безопасности День. Табло. Глобалисты провоцируют жёсткие санкции. В России Всемирный день писателя отмечается сравнительно недавно, с 1986 года, и считается неофициальным праздником. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN.
: техническим писателем ✒
В ИскраУралТел открыта вакансия Технического писателя В ИскраУралТел открыта вакансия Технического писателя Чем предстоит заниматься: - Коммуникации с заказчиком по защите и утверждению документации; - Разработка и утверждение документации по ГОСТ 19, 34; - Подготовка и согласование технических заданий; - Оформление требований. Теперь о вашем опыте и навыках, которые мы считаем ключевыми для вашей успешной работы.
Некоторые скажут, что они, дескать, и не писатели вовсе, так — просто инструкции составляют. И будут неправы. Но они должны много знать и доходчиво излагать свои мысли, уметь писать и одновременно разбираться в технике и технологиях, чтобы сложные вещи объяснить простым и понятным языком». Технический писатель изучает существующее оборудование или программу и, вникнув в них до уровня разработчика, пишет инструкции различного уровня, в том числе для пользователей, по которым со сложной программой или устройством без проблем сможет разобраться даже новичок. Таким образом, технический писатель — это профессиональный писатель, который разрабатывает, составляет, поддерживает и обновляет все виды технической документации, онлайн-помощи, руководств пользователя, инструкций, различных «мануалов» и «гайдов», разнообразных спецификаций и т.
Однажды он стрелялся с близким другом Кюхельбекером, потому что задел его обидной шуткой. В тот раз все обошлось, поскольку секунданты зарядили пистолеты клюквой вместо пуль. У Льва Толстого был очень неразборчивый подчерк. Чтобы издатели смогли напечатать его произведения, жена и дочь вынуждены были переписывать рукописи.
Положила учебник на коленки :grin: Учитель заметил, конечно, и влепил двойку. А ещё один раз я написала сочинение по какому-то произведению и получила 2 за то, что поняла его не так, как учитель".
Уже не помню, почему так случилось, помню только как мне было страшно и стыдно рассказывать об этом дома :scream: Когда приходила исправлять, учительница всё приговаривала: ну как же так, ты же умная девочка, неужели не вспомнила вот это правило? Часто писала по 6-7 страниц текста, а не сделать ошибок в таких длинных текстах сложно".
#Кем стать: Техническим писателем
Тестировать свои тексты на разной аудитории. Например, вы переписали непонятную инструкцию. Дайте её почитать другу-ровеснику, кому-то постарше и ещё кому-то, кто вообще не в теме. Попросите дать отзыв о вашей работе: что понятно, что нет. Получается такая импровизированная форма обратной связи, которую можно часто встретить в документации на сайтах. Форма обратной связи, текст которой тоже заполняет технический писатель Полезные ресурсы про тексты и интерфейс Технические писатели. Большой чат, где можно попросить совета, найти единомышленников, полезные материалы и даже работу.
Копилка текстов. Примеры текстов разной степени годноты. Техпишу и копирайчу. О техническом писательстве, текстах и развитии карьеры. Пишет техпис, прошедший за год путь от стажёра до мидла. Техпис говорит — подкасты о разработке документации.
Просто добавь в бэклог — про технические коммуникации и best practices в документировании и UX. А ещё — полезные книги: А. Мильчин, Л. Чельцова «Справочник издателя и автора». Ильяхов «Пиши, сокращай». Ильяхов «Ясно, понятно: как доносить мысли и убеждать людей с помощью слов».
Ильяхов, Л. Сарычева «Новые правила деловой переписки». Рыжкова «Текст за текстом. Как создавать контент системно, быстро и легко». Роэм «Бла-бла-бла, или Что делать, когда слова не работают». ЛеФевер «Искусство объяснять».
Симмонс «Сторителлинг. Как использовать силу историй». Черри «Продающие вопросы.
Ниже приведены основные преимущества: Общение. Одним из ключевых преимуществ конференций для технических писателей является возможность встретиться с коллегами из индустрии. Это не только позволяет обсудить актуальные тенденции и вызовы в области технического писательства, но и обменяться опытом и лучшими практиками. Встречи с единомышленниками могут стимулировать новые идеи и подходы к работе. Обучение и развитие навыков.
Конференции для технических писателей предлагают широкий спектр сессий, покрывающих различные аспекты профессии. От основных принципов технического писательства до новейших инструментов и технологий, используемых в отрасли. Участие в таких мероприятиях помогает техписам расширить свой арсенал навыков и оставаться в курсе последних тенденций в области. Практические знания и исследования. Конференции часто включают в себя практические сессии, мастер-классы и демонстрации продуктов, которые позволяют техническим писателям углубиться в конкретные аспекты своей работы. Это может быть рассмотрение конкретных кейсов использования, анализ современных тенденций в дизайне документации или изучение специализированных инструментов для улучшения процессов написания и публикации. Вдохновение и мотивация. Встречи с успешными профессионалами и истории их успеха могут дать новый импульс для развития собственной карьеры.
Помимо этого, присутствие на конференции создает ощущение принадлежности к сообществу, где каждый участник чувствует себя важным звеном в общей цепи. Они предлагают уникальную возможность обучения, установления полезных связей и вдохновения.
При всей её заезженности и радикальности я скорее склонна с этим тезисом согласиться. Не в последнюю очередь из-за того, что я сама не только технический писатель, но и переводчик. Перевод для меня — это упражнение, похожее на сборку конструктора или паззла, решение интеллектуальной задачки. Абсолютно то же самое я нашла и в техническом писательстве.
Прелесть этой работы в том, что здесь можно применять творческий подход, оставаясь в чётко очерченных рамках и решая конкретную задачу. А именно на стыке этих двух методов и происходит настоящая магия. Как говорила матерь всех переводчиков Нора Галь, «переводить надо не слово, не букву, а дух и смысл». И я верю в то, что этот принцип должен лежать в основе любой работы с текстом, особенно в работе технического писателя. С чем бы вы ни работали, думать о смысле — лучшее, что вы можете сделать для себя, для читателя и для заказчика. Это избавит вас от многих проблем и поможет решить большинство возникающих в работе вопросов.
И, конечно же, не только сделает ваш «перевод на пользовательский» полезным, но и заставит его звучать нативно. Хорошее владение IT-терминологией, погружение в IT-тематику. Действительно, техписам нередко приходится добавлять к документации схемы, графики, красивые таблицы и другие графические элементы. У некоторых компаний обозначено требование к наличию технического образования. Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon.
Наша команда трудится на благо одного департамента разработки. В департаменте 3 направления — у каждого свой техпис. Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач. Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды. Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов.
Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации. Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию.
Поэтому не исключайте возможность, что очередной проект может привести вас к команде мечты и новая глава вашей карьеры начнётся с качественной документации. Часто в вакансиях для технических писателей пишут про рост до аналитика. Из-за этого у меня складывается впечатление, что техпис — работа временная, точка входа в айти, потом нужно в кого-то вырасти. Но никто не запретит быть техписом хоть всю жизнь, если вы любите тексты и вам интересно всегда писать о разном. Марина Вашак, технический писатель Как научиться писать понятные инструкции Много писать — дневники, посты в соцсетях, каналы в «Телеграме». Читать — любую литературу: научпоп, художественную, научную. Развивать насмотренность. Изучайте инструкции к продуктам, которыми пользуетесь: банковским приложениям, сервисам доставки, такси, мессенджерам. Как они написаны, в каком формате, где лежат. Оценивайте, понятно ли вам. Если нет — пробуйте переписать, чтобы стало понятно. Тестировать свои тексты на разной аудитории. Например, вы переписали непонятную инструкцию. Дайте её почитать другу-ровеснику, кому-то постарше и ещё кому-то, кто вообще не в теме. Попросите дать отзыв о вашей работе: что понятно, что нет. Получается такая импровизированная форма обратной связи, которую можно часто встретить в документации на сайтах. Форма обратной связи, текст которой тоже заполняет технический писатель Полезные ресурсы про тексты и интерфейс Технические писатели. Большой чат, где можно попросить совета, найти единомышленников, полезные материалы и даже работу. Копилка текстов. Примеры текстов разной степени годноты. Техпишу и копирайчу. О техническом писательстве, текстах и развитии карьеры. Пишет техпис, прошедший за год путь от стажёра до мидла. Техпис говорит — подкасты о разработке документации. Просто добавь в бэклог — про технические коммуникации и best practices в документировании и UX. А ещё — полезные книги: А. Мильчин, Л. Чельцова «Справочник издателя и автора».
«День с писателем».
Поэтому какое-то время мечтала стать писателем. Самые свежие новости России и мира, новости политики, шоу-бизнеса. Мы ищем технического писателя в команду Indeed Access Manager. Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси. Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля. Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации.