25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. Новые инсайты и практика технологического обновления в программе Дня технического специалиста Форума PulpFor 2023! 120 лет со дня рождения писателя Владимира Григорьевича Сутеева/. С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. Умение создавать, редактировать, иллюстрировать и адаптировать технический материал, способность разбираться в незнакомых областях.
Новости дня
Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. Технические писатели. Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Жителей Молдавии призвали праздновать День Европы вместо Дня Победы.
Обязанности технического писателя
Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон. Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей.
Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы. Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями».
Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил. В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются.
Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки.
Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления. Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь».
Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком.
Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями. Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано.
Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений. Обычно это списки из пар «Название поля — описание».
Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна.
Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД. Есть руководства пользователя с подробным описанием каждой кнопки интерфейса. Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке.
Но в любом случае писатель должен быть внимательным, аккуратным и педантичным. Клиент всегда прав — отгрузка до 23. Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу. Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены. Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы. Большие надежды — портал bercut.
К примеру, поиск нужной информации можно выполнять только в рамках одного PDF-файла. Нельзя поискать описание какого-то параметра сразу во всей документации по системе. Это очень неудобно, ведь количество документов на одну систему часто исчисляется десятками. Если не знать, в каком документе искать нужные данные, то поиск превращается в нетривиальную задачу. Сейчас мы работаем над созданием портала, на который сможем выгрузить документацию в формате HTML. Там будет предусмотрен удобный полнотекстовой поиск по всем страницам или по части документации, например, по страницам на определенную версию определенной системы. Да здравствует Команда! Также по пятницам у нас обычно проходит еженедельное совещание нашей команды в Skype.
Эта традиция появилась у нас с переходом на удалённый режим работы. На совещании наш Team Lead делится с нами свежими новостями компании Bercut, рассказывает о новых краткосрочных и долгосрочных задачах и планах. Писатели по очереди рассказывают о своих задачах и рабочих проблемах — что сделано за прошедшую неделю, что планируется сделать на следующей. Такое обсуждение помогает нам скоординировать свои действия, ведь часто над пакетом документов к очередной версии системы работает сразу несколько писателей. Последний штрих Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Конечно, мы часто выполняем промежуточные синхронизации и в середине дня, но вечером обязательно проверяем, все ли изменения выгружены на сервер. Будет обидно, если вся работа, сделанная за день, пропадет даром. И конечно, надо не забыть оформить трудозатраты — вписать в задачи Jira время, которые мы на них потратили за этот день.
Призвание Работа технического писателя — сложная, но действительно интересная.
Политика и власть, бизнес и недвижимость, дороги и автомобили, финансы и работа, город и развлечения — вот только некоторые из тем, которые освещает ведущее петербургское сетевое общественно-политическое издание. Санкт-Петербург читает «Фонтанку»!
С кем-то это легко и просто, а из кого-то информацию нужно добывать. Сложно представить на месте технического писателя интроверта, которого приводит в ужас мысль, что надо разговаривать. Например, заказчик говорит, что ему нужна документация. У него есть макеты в «Фигме» и примерный флоу процесса.
Выглядит так, будто для полноценной документации этого недостаточно. Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст. Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно. Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру.
Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям. Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются. Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель. У разработчиков есть код-ревью.
У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной. И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай». Как понять, что работа мне подходит Возьмите приложение любимого банка и напишите инструкцию к какому-то простому процессу. Например, как оплатить мобильную связь. Покажите эту инструкцию друзьям или родителям, попросите проверить и попробовать пополнить баланс, следуя ей. Если инструкция сработала — поздравляю, это прекрасный старт, вы готовы к тестовым заданиям.
Помониторьте вакансии для технических писателей без опыта и запросите тестовое задание. Вас попросят описать реальный кейс или подготовить простую инструкцию к бытовым действиям или вещам. Однажды мне дали задание: написать инструкцию к кошке.
Лента новостей
| Военная операция на Украине | SQA ANALYST TECHWRITER DAYSСмотреть онлайн - Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей. |
| С Днем технического писателя! | 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. |
Кто читает инструкции?
- День технического специалиста на PulpFor 2023
- Вы можете заказать манипуляторы следующих моделей
- Вы можете заказать манипуляторы следующих моделей
- Солиста "Коррозии металла" оштрафовали за нацистскую символику
- Цены на аренду манипуляторов
- Зачем нужны техписатели?
Текста больше, чем кода
- Текста больше, чем кода
- День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
- Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
- Все новости
- День писателя
Презентация "Профессия Технический писатель" для студентов НИУ ВШЭ (27.10.2020)
Актуальные и свежие новости в стране и мире, эксклюзивные материалы и мнения экспертов. Технические писатели. День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. Умение создавать, редактировать, иллюстрировать и адаптировать технический материал, способность разбираться в незнакомых областях. Andrei Serikov in Технические писатели. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В.
Работа технического писателя в IT-компании: цели, зоны роста, кому подходит
5-6 апреля в Москве состоится 1-я Международная конференция технических писателей TechWriter Days. В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября. Презентация писателей – педагогов, внесших большой вклад в образование, подготовила библиотекарь ТТВТС Шевердяева И. В. TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией.
Текста больше, чем кода
- День писателя
- Новости | Центральная Библиотечная Система (ЦБС)
- Сузунская централизованная библиотечная система | Новости
- История профессии технического писателя: okwrite — LiveJournal
- Технический писатель
- TECHWRITER DAYS
: техническим писателем ✒
| #Кем стать: Техническим писателем | День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. |
| День технического перевода | Историю празднования Дня писателя узнают те, кто придет в библиотеку №107 (Перовское шоссе, д. 16/2). |
| TechWriter Days | 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. |
| День писателя | 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. |
| День технического перевода | 3 марта отмечается Всемирный день писателя. Этот праздник был учрежден в 1986 году по решению конгресса Международного ПЕН-клуба, который был основан в Лондоне в 1921 году. |
Новости дня
Самые свежие новости России и мира, новости политики, шоу-бизнеса. В Кургане ожидается спад уровня воды в Тоболе до 30 см в течение 1-2 дней. онлайн на сайте В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября.
Технический писатель
Контактные телефоны:.
Он выпустил 13 романов в цикле «Георгий Седов», большинство из них были написаны в 50-е годы. Написал «Арктический мост», «Фаэты», «Тайна нуля», «Острее шпаги», «Клокочущая пустота» и многие другие книги. Его последний роман «Звезда Нострадамуса» вышел в 2000-м, а в 2001-м в соавторстве с сыном он написал фантастико-автобиографический роман «Фантаст». Несмотря на обширную библиографию, прозу Александра Казанцева экранизировали лишь однажды. Ведущий советский разработчик методов комбинированных съемок Павел Клушанцев снял фильм «Планета бурь» 1961 по одноименной повести, в которой герои отправляются на Венеру. В книге писатель впервые использует слово «инопланетянин», которое вошло в обиход и стало привычным для всех.
Как писатель-фантаст Александр Казанцев дебютировал в 1936 году на конкурсе киносценариев. В соавторстве с Израилем Шапиро он написал сценарий фантастического фильма «Аренида» об астероиде, который грозит уничтожить Землю. Эта работа заняла первое место на конкурсе. Картина не была снята, но позже Казанцев на основе этого сценария написал роман «Пылающий остров» — свое первое произведение в жанре научной фантастики. Роман опубликовали в начале 1940-х годов, это стало началом 60-летней писательской карьеры. Он выпустил 13 романов в цикле «Георгий Седов», большинство из них были написаны в 50-е годы.
С чем бы вы ни работали, думать о смысле — лучшее, что вы можете сделать для себя, для читателя и для заказчика. Это избавит вас от многих проблем и поможет решить большинство возникающих в работе вопросов. И, конечно же, не только сделает ваш «перевод на пользовательский» полезным, но и заставит его звучать нативно. Хорошее владение IT-терминологией, погружение в IT-тематику.
Действительно, техписам нередко приходится добавлять к документации схемы, графики, красивые таблицы и другие графические элементы. У некоторых компаний обозначено требование к наличию технического образования. Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon. Наша команда трудится на благо одного департамента разработки. В департаменте 3 направления — у каждого свой техпис. Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач. Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды. Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов.
Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации. Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому.
Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе.
ВДНХ и городские библиотеки приглашают 3 марта на День писателя
Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. Умение создавать, редактировать, иллюстрировать и адаптировать технический материал, способность разбираться в незнакомых областях. Последние новости и события, происходящие в России и мире, а также комментарии и мнения экспертов. Новости дня читайте на Взгляде.