О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia.
Февральская встреча Сообщества технических писателей Санкт-Петербурга
«Приходится переводить с инженерского на русский»: как работают и сколько получают технические писатели в Москве. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. SQA ANALYST TECHWRITER DAYSСмотреть онлайн - Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей. Технический писатель: Новые тенденции и требования в документации '23 from Vlad Orlikov.
Кто такие технические писатели и зачем они нужны в команде
Выглядываю в окно, там почему-то пасмурно, это странно, потому что вчера было безоблачно и ничего не предвещало беды. Пью чай с мятой и съедаю микроскопический бутербродик: 5. Одновременно смотрю погоду, сегодня у меня много "уличных" планов намечается. Погода теплая, но мокрая: 6. Пора выходить на пробежку. Время: 7. Это стадион, на котором чудесное резиновое наверное покрытие, бегать одно удовольствие. Возможно сейчас пойдет дождь, но я сильная! Я не пугаюсь 8.
Срочно бегу в душ! Время: 10. Теперь можно полноценно позавтракать! Овсяная каша, огурец, помидор, хлеб и чай - радость для моего организма 11. Кошка тоже считаешь, что давно пора опять есть и составляет мне приятную компанию: 12. Завтрак поглощен, посуда помыта, кошка довольна, время: 13. До выхода из дома осталось чуть меньше двух часов, надо срочно позаниматься за фортепиано, а погодка кстати налаживается, выглядывает солнышко. Может быть, синоптики обманули нас с дождем?
Андрей Усачев - великий выдумщик! Настоящий профессор по неожиданным идеям и фантазиям. А идей и замыслов у него очень много. Недаром у этого автора вышло более ста книг!
Так он подписаны первые, начала 1920-х годов, поэтические сборники «Гроздь», «Горний путь» и который сохранился вплоть до конца 1930-х. В обиходе семьи Набокова использовалось три языка: русский, английский и французский. По собственным словам, он научился читать по-английски прежде, чем по-русски. Будучи лепидоптерологом Владимир Набоков открыл двадцать новых видов бабочек, а его произведения насчитывают 570 упоминаний различных видов бабочек.
В честь писателя были названы свыше 20 видов бабочек и род бабочек Nabokovia. Коллекцию бабочек в 4324 экземпляра после смерти Набокова его жена Вера подарила университету Лозанны. В шестидесятых и семидесятых годах Набоков последовательно отказывался от всевозможных предлагавшихся ему почетных титулов и состоял лишь в Обществе лепидоптерологов — регулярно платя членские взносы, но не желая, чтобы его имя значилось в списке членов. В 1985 году именем Набокова был назван астероид. Набоков отлично играл в шахматы и написал даже несколько собственных сложных шахматных задач.
Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы. Выходили и специальные выпуски, посвященные очередному съезду КПСС, выборам, праздничным датам, торжественным похоронам видных государственных и политических деятелей.
С Днем технического писателя!
Когда и где: 17-19 мая, Миннеаполис, США. Июнь Каждый год специалисты по технической коммуникации, включая разработчиков информации, технических писателей, технических редакторов и переводчиков, собираются на мероприятии Evolution of TC, которое фокусируется на новых разработках в области документации программного обеспечения. Данное мероприятие является единственной техкомм конференцией в Юго-Восточной Европе. Для получения более подробной информации обращайтесь на сайт конференции. Когда и где: 4-5 июня, София, Болгария. Knowledge Conf 2024 Программа конференции Knowledge Conf охватывает широкий спектр аспектов управления знаниями.
В ее рамках рассматриваются как прикладные задачи, включающие в себя обучение новичков, организацию базы знаний, создание внутренних университетов, а также практическое обучение, так и фундаментальные аспекты, такие как применение современных методов обучения и развитие системного мышления. Мероприятие позиционируется как профессиональная конференция по управлению знаниями и ее программа отражает этот слоган. Когда и где: 27-28 июня, Санкт-Петербург, РФ. Целью конференции является распространение существующих и создание новых знаний об архитектуре программных решений. Несмотря на то, что данное мероприятие не ориентировано на технических писателей, некоторые темы докладов могут быть интересны и им.
Конференция также будет проводиться онлайн, что позволит участвовать в ней без необходимости поездок. Когда и где: 1 ноября, Москва, РФ. Зачем техписам конференции? Итак, зачем же всё-таки техническим писателям посещать конференции?
Набоков получал образование в Кембриджском университете Тринити-колледж , где он продолжал писать русские стихи и переводить на русский язык «Алису в Стране чудес» Льюиса Кэрролла. В Кембриджском университете Набоков основал Славянское общество, впоследствии переродившееся в Русское Общество Кембриджского университета.
В Берлине он зарабатывал на жизнь уроками английского языка. В берлинских газетах и издательствах, организованных русскими эмигрантами, печатались рассказы Набокова. Романы Набокова, не печатавшиеся в Советской России, имели успех у западной эмиграции, и ныне считаются шедеврами русской литературы особенно «Защита Лужина», «Дар», «Приглашение на казнь». В Америке с 1940 до 1958 года Набоков зарабатывал на жизнь чтением лекций по русской и мировой литературе в американских университетах. С 1938 года и до конца своих дней Набоков не написал на русском языке ни одного романа. Новости по теме.
Наша аудитория — лидеры бизнеса и политики, чиновники, десятки тысяч горожан.
Будут ли пользователи читать сопроводительную документацию на сайте? Как организовать пополнение FAQ? Почему техрайтер должен участвовать в создании онбординга? Где техписателю найти информацию о разработке для iOS и Android?
Рекомендуем посмотреть ссылки в заметке Что почитать о разработке документации для мобильных приложений , чтобы с большей пользой провести обсуждение новой темы.
Наука и техника
| Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23 | Дневник писателя Ф. М. Достоевского. |
| Зачем нужны технические писатели | О том, как устроена работа технического писателя в сфере заказной разработки, рассказывает Сергей Кузьмишкин, руководитель подразделения в компании Notamedia. |
| Профессия технический писатель: чем занимается и как проходит типичный рабочий день | Киножурнал "Новости дня" выходил с 1944 по 1983 годы. |
Подробности
- Новости дня — последние и главные новости в России и мире сегодня на РЕН ТВ
- День рождения инженера и писателя-фантаста | Победа РФ | Новость от 02.09.2023
- 366. День технической книги
- АНОНС: TechWriter Days – Международная конференция технических писателей
- газета ЗАВТРА : Блоги
Один день из жизни технического писателя. Среда.
С целью напоминания о роли писательства в мире был учреждён Всемирный День писателя, который отмечается ежегодно 3 марта. Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна. Кастинг, вакансия для ДРУГОЕ: (Удаленка) Требуется технический писатель.
Наука и техника
Библиотекарь поселкового отделения познакомила воспитанников детского сада «Журавлик» с творчеством этого замечательного писателя. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. Сталин и писатели. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN.
Первый сбор
- День технического специалиста на PulpFor 2023
- Про плагиат
- 366. День технической книги
- День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
Кто такие технические писатели и зачем они нужны в команде
| День технического писателя | С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. |
| Оклад: 25000-30000 руб. | В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. |
Яндекс Образование
Опыт подготовки технической документации (ГОСТ 19, ГОСТ 34); - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. технические характеристики mitsubishi galant 25 i vr-4 type-v 4wd. Жителей Молдавии призвали праздновать День Европы вместо Дня Победы.
Физик и лирик. Технический писатель: Новые тенденции и требования в документации '23
Александр Клименков кандидат технических наук, Tech Lead Bercut Мы — сплоченная команда технических писателей. Сейчас нас одиннадцать человек: десять писателей и один технический редактор-переводчик. Среди нас есть инженеры, программисты, филологи и педагоги. Мы все очень разные: по возрасту, характеру, увлечениям и образованию. Но нас объединяет одно общее интересное дело — документирование сложных систем и решений. Бэкграунд Меня зовут Александр Клименков, я — ведущий технический писатель, кандидат технических наук по специальности «Системный анализ, управление и обработка информации», закончил Санкт-Петербургский электротехнический университет «ЛЭТИ». В компании Bercut работаю более 5 лет, очень люблю свою профессию. До прихода в Bercut работал преподавателем, техническим писателем и ведущим бизнес-аналитиком. Процессы и коммуникации в новой дистанционной реальности Как и большинство наших коллег в IT-сфере, сейчас мы работаем из дома. Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись.
Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами. Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах. Биоритмы и конвенции Режим рабочего дня, как и процессы, тоже не особо изменился. Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11. Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время. В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы. Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN.
Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день. У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть. Об этом нужно рассказать подробнее. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид.
Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы.
Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы.
Фото: РИА Новости 01. Фото: РИА Новости 189204 0 117 лет назад, 2 сентября 1906 года, в Акмолинске сегодня — Астана, столица Казахстана родился изобретатель, писатель-фантаст Александр Казанцев. После окончания Томского технологического института он работал инженером-механиком, но увлекшись изобретательством, перешел работать во Всесоюзный научно-исследовательский институт электромеханики. Когда Александру Казанцеву было 35 лет, началась Великая Отечественная война. В армии он служил заместителем командира саперного батальона, причем в звании рядового. Он предложил наладить выпуск для фронта дистанционно управляемых торпед-танкеток, его изобретение использовали во время прорыва блокады Ленинграда.
Затеси очень разные по своему содержанию и объему, порой это всего несколько абзацев. Сам автор дает такое определение: «Затесь — сама по себе вещь древняя и всем ведомая — это стёс, сделанный на дереве топором или другим каким острым предметом. Делали его первопроходцы и таежники для того, чтобы белеющая на стволе дерева мета была видна издалека, и ходили по тайге от меты к мете, часто здесь получалась тропа, затем и дорога, и где-то в конце ее возникало зимовье, заимка, затем село и город». На выставке представлено первое издание «Затесей» 1972 года. Всего писатель создал свыше двухсот художественных произведений, которые издавались более ста раз почти в тридцати странах. Экспозиция состоит из пяти разделов, каждый из которых носит название географических мест, где жил и работал писатель. Они были не только частью биографии Астафьева, но и неизменно присутствовали в его произведениях. Раздел «Игарские затеси» рассказывает о детских годах жизни драматурга и его трудах, в которых описывается заполярный город Игарка. Интерес представляет уникальное издание «Игарские затеси» Валентины Гапеенко.
Газета.Ру в соцсетях
Технический день в модельной библиотеке им. М. Е. Салтыкова-Щедрина перенесен на 22 февраля. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. Но больше всего услуги технического писателя востребованы, как мы уже отметили, в сфере информационных технологий.