Один или два параграфа о том, почему вы самый крутой писатель технических новостей в блоке. К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты о писателе, который считается и русским, и американским. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. 5-6 апреля в Москве состоится 1-я Международная конференция технических писателей TechWriter Days. Станислав, вы описали самый отличный день технического писателя.
Поиск по сайту
- День из жизни технического писателя.
- Рекомендации
- Зачем нужны техписатели?
- Забыли пароль?
«День с писателем».
Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. Свежие новости Москвы на сегодня и завтра. Какое метро откроют, какими будут «Лужники». Последние новости на официальном сайте Мэра Москвы. Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации.
Первый «Доквариум» пройдёт 28 июля
- Зачем нужны технические писатели – информатика тесты
- Газета.Ру в соцсетях
- TechWriter Days
- Текст как призвание
- Информация
- Информация
История профессии технического писателя
Наш Toolkit позволяет собирать документы во множестве форматов. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид. Подробнее о формате Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться.
Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов. После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC.
Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию.
Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Также напоминаем, что 23 февраля библиотека не работает в связи с официальным праздником — Днем защитника Отечества. В остальные дни февраля будем рады видеть читателей согласно нашему привычному графику работы.
По итогам 2018 г. Уверенное владение офисным пакетом Microsoft Office работа со стилями, многоуровневыми списками, перекрестными ссылками и т.
Хотя есть и те, кто попробовали и перешли в разработку, аналитику, управление проектами. И я, кстати, только рада, что ребята дальше несут культуру документации — легко писать качественную доку, когда вас целый отдел, все друг друга вычитывают и часами могут обсуждать нюансы формулировок. А вот когда документация — вспомогательная деятельность, начинаются сложности. Поэтому я радуюсь каждый раз, когда люди приходят обсуждать доку, подходы к ней, инструменты — это же не только о техписателях, но о гигиене ИТ в целом. Какую документацию готовит техпис? Если коротко — почти любую техническую документацию. На самом деле, объём и типы документации от компании к компании могут сильно отличаться. Мануалы, инструкции, справочные материалы, FAQ по продуктам компании для конечных пользователей — это прямая обязанность. Спецификации, справочная информация для разработчиков, внутренняя документация для взаимодействия внутри команд и между ними, корпоративные базы знаний — не прямая обязанность, но часто перепадает именно на долю технического писателя или он как минимум всё это проверяет, упорядочивает и доводит до ума. UX-тексты подсказки, пункты меню, и т. Технические переводы с русского на иностранный и обратно — чаще всего именно задача техписа, но здесь есть нюанс с владением языками, поэтому нередко ему помогают переводчики особенно в мультиязычных компаниях. Теодора Малевинская Держатель профессии «технический писатель» в Тинькофф О себе: Строю техписательские процессы для разработчиков, собираю редакции, развиваю профессиональное сообщество в компании и вне. Я очень люблю обращаться к статистике — это аргументы, которые я часто привожу: Исследование 1 В 2016 StackOverflow провёл исследование среди разработчиков о том, с какими проблемами они сталкиваются в работе. Исследователи делают вывод: «Это показывает как важно для компаний иметь хорошо написанную документацию». Исследование 3 Nintex проводили исследование о самых неэффективных процессах в ИТ-компаниях. Я сама наблюдаю, что часто такая проблема бывает из-за того, что какие-то ошибки или процессы не описаны в документации. Источник В целом мы видим, что разработчики читают документацию, но большинство сталкивались с проблемой: её не было или она была неполной. Плохая документация — это неоправданно дорого для компаний. Особенно, если она к продукту, которым пользуются многие. За последние четыре года не раз видела случаи, когда технический писатель переписывал инструкцию и экономил часы и дни разработчиков. Например, техписатель понятно переписал онбординг, который прошли 500 человек. Это заняло у них 3 дня, а не 5. Оставшиеся 8000 часов можно потратить на разработку фич или ещё что-то полезное для компании, ведь теперь им не надо писать вопросы в чат поддержки. Что должен знать и уметь технический писатель? Это тоже зависит от компании, продукта и существующих задач, но мы с вами обратимся к Хабр Карьере и посмотрим, что требует рынок. Есть почти во всех вакансиях в той или иной мере. В любом случае знание ГОСТ сильно облегчает работу и дарит навык структурирования.
(Удаленка) Требуется технический писатель.
Известный нижегородский писатель Валерий Шамшурин так сказал о нем. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. Смотрите онлайн самые последние и важные новости канала ОТР на официальном сайте. 21 апреля в ГУНБ в отделе технической литературы (3 этаж, каб. 301) пройдет День технической книги.
Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
Технических писателей. Конференция предоставляет техническим писателям возможность обмениваться опытом, учиться новым методам и инструментам, а также повышать свой профессиональный уровень в области создания технической документации. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. Жителей Молдавии призвали праздновать День Европы вместо Дня Победы.
Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
На фронт он пошел добровольцем, служил шофером, артиллеристом, разведчиком, связистом, пока в 1944 г. В раздел «Солдатские затеси» вошли произведения на военную тему, написанные автором по своим воспоминаниям: «Прокляты и убиты», «Где-то гремит война», «Пастух и пастушка». Также можно ознакомиться с первой публикацией повести «Веселый солдат» в журнале «Новый мир» 1998 г. Город Чусовой — литературная родина Виктора Астафьева. Он жил здесь в 1945-1962 гг. В разделе «Чусовские затеси» представлена книга «По следам "Веселого солдата"» Владимира Маслянки, в которой большая часть материала посвящена журналисту Астафьеву. В разделе «Вологодские затеси» рассказывается о жизни писателя в Вологде, его работе над «Затесями» и романом «Царь-рыба», который принес Виктору Астафьеву всесоюзную известность. В 1978 г. Раздел «Красноярские затеси» посвящен заключительному периоду творчества драматурга.
Еще во времена студенчества Сутеев стал членом экспериментальной группы мультипликаторов. Мультипликационный дебют мужчины состоялся во время его работы над картиной «Китай в огне». В данной картине впервые был использован альбомный метод мультипликации. В 1924-1925 годах художник занимался рисованием рекламных киноплакатов для таких фильмов, как «Девушка в маске», «Куртизанка», «Жена фараона» и многие другие.
Главное — не допускать ошибок фактических. Каждый должен заниматься своим делом. Например, математику или физику часто проще написать формулу, чем объяснить словами какой-то закон. Программисту проще выражать свои мысли в виде кода и алгоритмических конструкций. Когда же дело доходит до формулирования чётких и понятных текстов на русском или другом языке, в дело вступает технический писатель. Это тот самый специалист, который переводит информацию с языка разработчиков на язык пользователей. Не было бы технических писателей, и программистам пришлось бы самим напрягаться, пытаясь объяснить такие понятные и очевидные для них вещи обычным пользователям системы. Стройная система подпорок и противовесов Хогвартс напоминает любой IT-проект, который разрабатывается долгое время. Древние баги, нигде не прописанные фичи, несовместимости, куча сдерживающих этот ужас костылей и несколько программистов, которые даже не хотят лезть в неведомые глубины и гордо называют их «школьными традициями». Мы уже привыкли и считаем нормальным, что у наших программ есть много недокументированных возможностей. Если система живёт и развивается уже несколько лет, то в ней с каждым годом появляется всё больше исключений из правил. В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются. Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов. Так и остаются в системе старые и недействующие параметры и настройки. Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления. Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь». Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации. Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями. Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано. Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений.
Олег Рябов - писатель, главный редактор журнала "Нижний Новгород", член Союза писателей России: «Это основная тема для меня. Я могу писать фантастические рассказы, могу писать про нечисть, какую-то там, русалок, домовых, но это основная тема, которая для меня и болезненна и свята, это мой родной город». Во многом тексты Олега Рябова автобиографичны — в них есть близкие ему люди и места. Так и новый роман автора — "Позови меня, Ветлуга" о зове Родины, на который откликаются герои — пусть даже неосознанно. Так, по мнению Олега Рябова, хороший писатель должен, в первую очередь, писать.
День писателя
Написал «Арктический мост», «Фаэты», «Тайна нуля», «Острее шпаги», «Клокочущая пустота» и многие другие книги. Его последний роман «Звезда Нострадамуса» вышел в 2000-м, а в 2001-м в соавторстве с сыном он написал фантастико-автобиографический роман «Фантаст». Несмотря на обширную библиографию, прозу Александра Казанцева экранизировали лишь однажды. Ведущий советский разработчик методов комбинированных съемок Павел Клушанцев снял фильм «Планета бурь» 1961 по одноименной повести, в которой герои отправляются на Венеру. В книге писатель впервые использует слово «инопланетянин», которое вошло в обиход и стало привычным для всех. Эту картину купили на Западе, причем показывали не только оригинальный вариант, но перемонтировали в два варианта с названиями «Путешествие на доисторическую планету» и «Путешествие на планету доисторических женщин».
Работа технического писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Кому нужен технический писатель.
Если проект небольшой, то возможно, технический писатель совсем не нужно. Но есть огромные преимущества, когда в проекте есть технический писатель. Технические писатели четким языком излагаю информацию. Большинство технических специалистов являются экспертами в своей области, они формируют описание продукта для равной себе аудитории. Для конечных же пользователей нужны совершенно другие инструкции. Технические писатели по своей сути являются переводчиками с языка разработчиков на простой язык, который требуется пользователям продукта. Особенно важно сочетание слов и графики — именно такой формат позволяет создать инструкцию, понятную всем участникам проекта. Кроме того, технические писатели смогут оказать помощь в изменении пользовательского интерфейса продукта, что позволит снизить потребность в документации.
Документация хорошего качества положительно влияет на продукт. Грамотные и понятные инструкции уменьшают количество обращений в отдел технической поддержки: Технические писатели думают о задаче с точки зрения пользователя, а не разработчика. Поэтому они лучше объясняют, как пользователи могут достичь своих целей. Технические писатели могут усовершенствовать доступ к информации, и таким образом снизить количество обращений в техподдержку, которое несомненно возрастает, если пользователи не могут найти необходимую им информацию. Документируя продукт, технические писатели тестируют его, чтобы узнать, как он работает на самом деле. В это время они часто обнаруживают баги или проблемы с удобством использования. Устранив эти проблемы до релиза продукта, можно быть уверенным, что пользователи никогда не столкнутся с ними. К тому же, технические писатели часто формируют более целостный взгляд на продукт, чем может получиться у разработчиков, которые должны сосредотачиваться каждый на своей небольшой части продукта.
Технические писатели накапливают полезный опыт, работая с пользовательскими интерфейсами — это то, что большинство разработчиков никогда формально не изучали. Предлагая рационализированный, более эффективный вариант интерфейса, технический писатель освобождает время разработчиков, которое они смогут потратить на более трудоёмкие задачи по созданию корректно работающего кода. Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя — писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно — он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты. Даже если «этот снаружи» сидит в соседней команде. Любое погружение посторонних в проект или продукт уже подразумевает документацию, а, следовательно, и позицию технического писателя.
Но у меня в практике был проект, когда документации нет и это не создаёт никаких реальных проблем. Вот тогда и писатель не нужен. Или к примеру, у меня в команде был такой разработчик, что он прекрасно пишет документацию и ему проще сделать это самому — вот такое у него хобби » Максим, директор департамента разработки ИТ-компании Какую карьеру может построить технический писатель? Технический писатель может выбрать для себя разные пути развития. Очень многое зависит от проекта, над которым работает технический писатель. Если брать сферу IT, ближе всего к техническому писателю профессия бизнес-аналитика. Там требуются схожие качества: внимание к деталям, аналитический склад ума, стремление разложить все по полочкам. Из технического писателя получаются прекрасные специалисты по тестированию.
Технический писатель может стать менеджером проектов, попробовать себя в тестировании. Если человек писал много документации о программах на Java, заинтересовался и решил изучить этот язык программирования, он может стать разработчиком.
В планах еще автоматизировать отправку md-файлов напрямую в Confluence. Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т.
В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему. Пока сделать перерыв и пойти выпить кофе.
С кофе главное правило — не увлекаться. Наливаю кофе и иду к обратно.
Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему. Пока сделать перерыв и пойти выпить кофе. С кофе главное правило — не увлекаться.
Наливаю кофе и иду к обратно. Это мой первый обед, стараюсь делить прием пищи на два раза, так полезнее. Очень вкусно.