Конференция для технических писателей – это событие, организованное с целью собрать и объединить специалистов, занимающихся технической документацией. Должность: технический писатель, хотя в последнее время скорее knowledge manager. Самые свежие новости России и мира, новости политики, шоу-бизнеса. Иркутского Государственного Технического Университета ISSN. Самые свежие новости России и мира, новости политики, шоу-бизнеса.
Подпишитесь на рассылку
- Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
- Работа технического писателя в IT-компании: цели, зоны роста, кому подходит
- Профессия технический писатель: чем занимается и как проходит типичный рабочий день
- День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
Открылась выставка «С красной строки» к 100-летию со дня рождения писателя Анатолия Митяева
Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна. технические характеристики mitsubishi galant 25 i vr-4 type-v 4wd. День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. В Кургане ожидается спад уровня воды в Тоболе до 30 см в течение 1-2 дней.
366. День технической книги
Технический день в модельной библиотеке им. Салтыкова-Щедрина перенесен на 22 февраля 17 февраля 2022 Уважаемые читатели! В феврале в модельной библиотеке им.
Новгород, 1999. Ночные костры; Ю. Странноприимный дом.
Новгород, 2002. Новгород, 2006. Новгород, 2001. Дом-корабль: рассказы детям о взрослых и взрослым о детях. Новгород: Фонд «Народный памятник», 2006.
Жизнь и творчество. Протоиерей Владимир Гофман. Ответы на вопросы прихожан.
С 1984 года журнал поменял своё название на «Хроника наших дней» изменились заставка и музыка журнала. В ряде городов СССР, например, в Минске, были созданы специальные кинотеатры «Новости дня» для демонстрации выпусков одноименного киножурнала.
Будут ли пользователи читать сопроводительную документацию на сайте? Как организовать пополнение FAQ? Почему техрайтер должен участвовать в создании онбординга? Где техписателю найти информацию о разработке для iOS и Android? Рекомендуем посмотреть ссылки в заметке Что почитать о разработке документации для мобильных приложений , чтобы с большей пользой провести обсуждение новой темы.
(Удаленка) Требуется технический писатель.
Особый интерес представляет тот факт, что организаторами этого мероприятия являются те же люди, которые организуют такие успешные конференции, как SQA Days и Analyst Days. Кроме того, Документерра является серебряным партнером конференции и выступит с докладом о мировых тенденциях в области документации. Приглашаем вас присоединиться к нам, чтобы послушать выступление нашего технического директора и принять участие в обсуждении. Будем рады видеть вас на мероприятии! Когда и где: 5 — 6 апреля, Москва, РФ. Write the Docs 12-я ежегодная конференция Write the Docs в Портленде приглашает участников технического сообщества поделиться своими идеями и знаниями.
Изначально мероприятие проводилось для разработчиков, но теперь оно включает всех, кто проявляет интерес к документации. Конференция нацелена на объединение специалистов по документации для обмена опытом, укрепления профессиональных связей, приобретения новых навыков, вдохновения и приятного времяпрепровождения. Дополнительную информацию можно получить на сайте конференции. Когда и где: 14 — 16 апреля, Портленд, США. Это событие соберет вместе профессионалов различных направлений в индустрии разработки: backend, frontend и fullstack-разработчиков, тестировщиков и QA-специалистов, web-дизайнеров и проектировщиков интерфейсов, системных аналитиков, тимлидов, техлидов и менеджеров разработки.
Участникам будет предоставлена возможность рассказать о своей компании, продуктах и новых проектах. Техническим писателям также будет интересно присоединиться! Когда и где: 26 апреля, Екатеринбург, РФ. Будучи самой старой организацией в данной области, STC предоставляет широкие возможности для общения и обучения у коллег, интенсивные сессии по ключевым темам и обновлениям в отрасли.
Текстильщики в шаговой доступности от метро Выходной день в честь дня рождения.
Дополнительную информацию можно получить на сайте конференции. Когда и где: 14 — 16 апреля, Портленд, США. Это событие соберет вместе профессионалов различных направлений в индустрии разработки: backend, frontend и fullstack-разработчиков, тестировщиков и QA-специалистов, web-дизайнеров и проектировщиков интерфейсов, системных аналитиков, тимлидов, техлидов и менеджеров разработки.
Участникам будет предоставлена возможность рассказать о своей компании, продуктах и новых проектах. Техническим писателям также будет интересно присоединиться! Когда и где: 26 апреля, Екатеринбург, РФ. Будучи самой старой организацией в данной области, STC предоставляет широкие возможности для общения и обучения у коллег, интенсивные сессии по ключевым темам и обновлениям в отрасли. Это мероприятие способствует постоянному развитию знаний, навыков и общения для профессионалов в области технической коммуникации. Более подробную информацию о программе саммита можно найти на сайте STC. Когда и где: 17-19 мая, Миннеаполис, США. Июнь Каждый год специалисты по технической коммуникации, включая разработчиков информации, технических писателей, технических редакторов и переводчиков, собираются на мероприятии Evolution of TC, которое фокусируется на новых разработках в области документации программного обеспечения. Данное мероприятие является единственной техкомм конференцией в Юго-Восточной Европе.
Для получения более подробной информации обращайтесь на сайт конференции. Когда и где: 4-5 июня, София, Болгария. Knowledge Conf 2024 Программа конференции Knowledge Conf охватывает широкий спектр аспектов управления знаниями.
Настоящий профессор по неожиданным идеям и фантазиям. А идей и замыслов у него очень много.
Недаром у этого автора вышло более ста книг! В его произведениях много юмора и доброты.
Февральская встреча Сообщества технических писателей Санкт-Петербурга
Один или два параграфа о том, почему вы самый крутой писатель технических новостей в блоке. Роль технического писателя Технический писатель переводит «от разработчика – клиенту». Во Всемирный день писателя вручаются награды и премии проявившим себя литературным деятелям.
Кто такие технические писатели и зачем они нужны в команде
Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна. Опыт подготовки технической документации (ГОСТ 19, ГОСТ 34); - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию. Опыт работы в аналогичной должности (или инженером – электроником) от одного года. В свою очередь, технический писатель вносит исправления и проверяет, чтобы они соответствовали остальному тексту. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования.
Яндекс Образование
А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» merge куски сложных технических текстов.
После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки.
Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально.
Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП.
На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах.
Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
У нас в Notamedia есть кейс с сотрудником, который ранее работал на стороне заказчика и занимался проверкой формальной стороны договоров. Типичный подводный камень в договоре — исполнитель должен уведомить заказчика за 5 дней до проведения испытаний о том, что он к ним готов.
И если он этого не сделал — начинаются проблемы. И этот сотрудник обладает способностью быстро вычитывать договоры, сразу подмечая места в документе, где могут возникнуть проблемы. Это полезно, так как РП тяжело погружаться в эти юридические тонкости.
И здесь задача технического писателя — прикрывать РП по формальной части. Вертикальный рост технического писателя Вертикальный рост технического писателя прост и понятен. В подразделении Nota.
Docs четко выстроена градация между специалистами уровня Junior, Middle и Senior: Junior — новичок, обладающий базовыми компетенциями: грамотность, владение MS Office, системность и структурированность мышления, внимательность к деталям. Но ему нужна помощь от более опытных коллег по ряду вопросов. Middle — это человек с опытом, который работает самостоятельно.
Если ему поставили задачу, он не прибегает к помощи других коллег-техписов. Это не означает, что он не имеет права задавать вопросы другим участникам проектной команды. Но значит то, что за ним не надо проверять.
Он знает, как добыть информацию, к кому пойти по тому или иному вопросу и знает срок, к которому все должно быть сделано, а также в каком объеме и качестве. Senior — это уже расширенные компетенции и нечто большее, чем все функциональные обязанности специалиста Middle. Это «большее» может быть с точки зрения, например, управленца — то есть человек, который ставит задачи нескольким мидлам.
Или человек, который глубоко знает определенную предметную область или систему. Поэтому специалист может вырасти до ведущего технического писателя, в подчинении которого находится несколько специалистов, затем — в руководителя подразделения технической документации. Кому подходит карьера технического писателя Главное качество, которое отличает технического писателя — это ответственность.
Потому что мы работаем с формальным треком, который с крупным заказчиком проходит через его внутренний электронный документооборот, сопроводительные бумаги и письма. Поэтому невозможно физически договориться о том, что мы сегодня не успели и сделаем завтра. Если срок сдачи документа — 30 сентября, то не позднее этого дня он должен быть любой ценой.
Но при этом вариативность типа личности, которому подходит карьера технического писателя, велика. Есть люди, которые целый день проводят в переговорах, обсуждении договоренностей и планов. А есть те, кто сидит и разбирается в функциональности продукта, выясняет, что за полгода сделали разработчики.
Именно от специфики проекта зависит тот склад ума и характера человека, который под него подходит. Предположим, в компании открыто несколько вакансий технических писателей на разные проекты. Давайте смоделируем несколько ситуаций: проектов и подходящих под них типажей кандидатов.
Типаж 1 — «библиотечный бука» Есть проект А, на котором приходится писать сложные документы. Например, пояснительную записку на 1000 страниц с техническими подробностями. Человек, который подходит под этот проект, может быть не очень коммуникабельным, но должен быть своеобразным «библиотечным букой»: зарыться в техническую информацию и сидеть с ней разбираться, выстраивая из этого стройный текст.
Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними.
Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов. Презентация документации заказчику.
Передача документации команде. Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено. Своих технических писателей я учу: при постановке задачи важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду.
Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать, иначе процесс может затянуться». Елена, технический директор IT-компании Что должен знать и уметь технический писатель. Профессии технического писателя в российских вузах не учат. Есть курсы, где можно научиться писать технические тексты, но их немного. Поэтому осваивать такую профессию часто приходится по статьям в интернете, ориентируясь на примеры других.
Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений. В отличие от копирайтинга, здесь меньше творчества и больше регламентов. Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли. Технический писатель должен сочетать в себе свойства технаря и гуманитария. Интерес к технике и программированию, усидчивость и внимательность должны в нём сочетаться с желанием осваивать новое и делиться своими знаниями.
Очень важно знать предметную область, в которой ведется работа. Например, если вакансия открыта в ИТ-компании, потребуется знать языки программирования и разбираться в процессах разработки софта. Список ПО зависит от отрасли, в которой трудится специалист. Нужно уметь работать в команде, общаться с разработчиками и понимать пользователей, которые будут использовать продукт. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями.
В некоторых IT-компаниях требуется, чтобы технический писатель знал языки разметки текста или один из языков программирования на уровне чтения кода, другим важны навыки работы с базами данных или в системах управления запросами. То, что пригодится точно — интерес к той сфере, о которой технический писатель работает. Некоторые работодатели требуют, чтобы образование у технического писателя было техническим. Другим нужно просто высшее образование. Еще одно требование — знание иностранного языка, потому лингвисты, филологи, переводчики тоже востребованы.
Хорошо пишут тексты и коммуникабельны, как правило, выпускники гуманитарных направлений: литераторы, журналисты. Если человеку с таким образованием понравится разбираться в новой для себя области, то, скорее всего, ему подойдет эта профессия.
Возможно сейчас пойдет дождь, но я сильная! Я не пугаюсь 8. Срочно бегу в душ! Время: 10. Теперь можно полноценно позавтракать! Овсяная каша, огурец, помидор, хлеб и чай - радость для моего организма 11.
Кошка тоже считаешь, что давно пора опять есть и составляет мне приятную компанию: 12. Завтрак поглощен, посуда помыта, кошка довольна, время: 13. До выхода из дома осталось чуть меньше двух часов, надо срочно позаниматься за фортепиано, а погодка кстати налаживается, выглядывает солнышко. Может быть, синоптики обманули нас с дождем? Позанималась вполне продуктивно, выучила 4 такта, которые никак не получались три дня подряд. Кошечка считает что ей тоже нужно заниматься, при чем срочно! Иначе кого-то покусают. Гимнастика с красной ленточкой: 15.
После утомительных упражнений, я желаю кошке хорошенько выспаться и отдохнуть, она мне тоже желает не перетрудиться: 16. Пора выходить на работу. Время: 17.
Зачем нужны технические писатели
Демонстрировался в кинотеатрах перед киносеансами. Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы.
Санкт-Петербург читает «Фонтанку»! Наша аудитория — лидеры бизнеса и политики, чиновники, десятки тысяч горожан.
Набоков получал образование в Кембриджском университете Тринити-колледж , где он продолжал писать русские стихи и переводить на русский язык «Алису в Стране чудес» Льюиса Кэрролла.
В Кембриджском университете Набоков основал Славянское общество, впоследствии переродившееся в Русское Общество Кембриджского университета. В Берлине он зарабатывал на жизнь уроками английского языка. В берлинских газетах и издательствах, организованных русскими эмигрантами, печатались рассказы Набокова. Романы Набокова, не печатавшиеся в Советской России, имели успех у западной эмиграции, и ныне считаются шедеврами русской литературы особенно «Защита Лужина», «Дар», «Приглашение на казнь». В Америке с 1940 до 1958 года Набоков зарабатывал на жизнь чтением лекций по русской и мировой литературе в американских университетах.
С 1938 года и до конца своих дней Набоков не написал на русском языке ни одного романа. Новости по теме.
В зависимости от этого, описание выполняется на языке, понятном представителю одной из ролей. Например, для пользователя нужно писать «простым» языком, давать подробный порядок действий, для разработчика, напротив, нужны четкие формулировки с терминами, описание рабочих примеров кода. Вам сложно понять, что нужно писать, с чего начинать, как писать?
Не переживайте. Для каждого типа описываемого объекта, например, справочник, сценарий или установка, имеется отдельный формат описания. Формат задает структуру описаний, предоставляет готовые типовые фразы, правила оформления текста. Проще говоря, формат — это шаблон для новых текстов. Мы пишем не поэмы, не повести, требующие творческой окраски, мы пишем техническую документацию, которая должна быть простой, структурированной и понятной любому. Запускаю программу и поочередно описываю каждую ее вкладку: «Основное окно», «Настройки».
Обязательно добавляю назначение программы и общие разделы, например, «Способы запуска». Структуру текста я как раз беру из готового формата описания. Если возникают вопросы, ответы на которые не удалось найти ни в технических проектах, ни в интернете, можно напрямую обратиться с вопросами к разработчику. Бояться тут нечего. Каждый сотрудник компании дружелюбно ответит вам либо перенаправит к человеку, который более компетентен в поставленном вопросе. Не забывайте, мы же одна команда!
В перерывах между описаниями наступает обед. Время на работе течет в быстром темпе, не успеешь и заметить, как утро кончится.