Вы узнаете о том, как становятся техническими писателями, насколько путь техписателя тернист и интересен, почему документация важна.
Презентация "Профессия Технический писатель" для студентов НИУ ВШЭ (27.10.2020)
На сайте в рубрике «Наука и техника» всегда свежие новости за день и неделю. Киножурнал "Новости дня" выходил с 1944 по 1983 годы. Меня зовут Елена, мне 23 года, я живу в Москве, работаю техническим писателем. Представляю свой будний день 10 июля 2012 года. В связи с отсутствием профессионального праздника у технических писателей предлагаю учредить его самостоятельно и ежегодно праздновать 17 сентября. Киножурнал "Новости дня" выходил с 1944 по 1983 годы. Новости дня читайте на Взгляде.
Процессы и коммуникации в новой дистанционной реальности
- Конференции: полезный ресурс для технических писателей
- Первый «Доквариум» пройдёт 28 июля | Разработка технической документации
- Зачем нужны технические писатели – информатика тесты
- Научно-техническая библиотека им. Н. Г. Четаева
- Регулярные расходы
- Научно-техническая библиотека им. Н. Г. Четаева
Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей.
В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке.
ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Один в поле не воин Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками.
Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику.
Здесь вы отыщете наиболее значимые происшествия, новости Санкт-Петербурга, последние новости бизнеса, а также события в обществе, культуре, искусстве. Политика и власть, бизнес и недвижимость, дороги и автомобили, финансы и работа, город и развлечения — вот только некоторые из тем, которые освещает ведущее петербургское сетевое общественно-политическое издание.
А ошибки в отчетной документации приводят к провалу испытаний или вовсе к отказу в приемке работ. Для технического писателя важно не зацикливаться на самом тексте, а смотреть в суть. Прийти к разработчику и спросить: «Все ли я правильно понял и написал? Еще один важный момент — технический писатель должен не только предоставить заказчику комплект отчетной документации, но и согласовать ее с ним.
Если клиенту что-то не нравится — выяснить, что именно, и понять, как это исправить. Куда расти техническому писателю Представим ситуацию, что человек приходит на позицию технического писателя, перерастает грейд Junior и в какой-то момент начинает думать: «А куда дальше развиваться? Буду ли я до конца карьеры писать технические документы, такие как руководство пользователя? У технического писателя есть конкретные зоны роста — как горизонтального, так и вертикального. Поговорим о горизонтальном росте подробнее. Хороший технический писатель должен знать, какие шаги нужно пройти для успешной сдачи проекта. Это шаги, которые находятся не только в его компетенции, но и которые должны пройти другие участники команды: дизайнеры — нарисовать макеты, разработчики — написать код, аналитики — описать бизнес-процессы. И контроль выполнения работ другими участниками команды тоже может быть в числе обязанностей техписа. Также техпис должен уметь оценивать затраты на разработку той или иной документации: Сначала сформулировать требования к другим участникам команды — в каком виде и в какие сроки ему должны предоставить исходные данные для формирования комплекта отчетной документации. С учетом качества и количества исходных данных прикинуть свои трудозатраты на формирование отчетной документации.
Уложить это все на план-график исполнения контракта, понять, сколько нужно людей, какой трек согласования документации, и как вообще при этом выжить. То есть это процессное и ресурсное управление, которым он должен владеть. И это схожие процессы с теми, которые есть у руководителя проекта. Что из этого следует: техпис может быть правой или левой рукой руководителя проекта и, соответственно, в этом направлении развиваться. Так что хороший техпис может вырасти до РП. Иногда это классическая аналитика при ведении проектов, когда сначала есть общие верхнеуровневые требования, а затем надо проговорить с заказчиком, что сделать — декомпозировать эти требования, провести трассировку, управлять ими. Бывают и неклассические аспекты аналитики. Например, мы берем проект, которым ранее занимался другой подрядчик. И теперь нам надо его развивать. Стартовая задача технического писателя — это разобраться в этом проекте, провести Reverse engineering технической части проекта: что написано, как это работает.
Вторая задача — посмотреть на документы, какие были договоры и технические задания. И понять, что реально представляет собой проект или конкретный продукт, и соотнести с тем, что написано в документах. То есть это Reverse engineering с прицелом на формальную часть. Сергей Кузьмишкин, руководитель подразделения Nota. Docs Нетипичный случай аналитики также возникает, когда нужно обосновать заказчику стоимость работ в ходе формальных процедур по подготовке к конкурсу. И тут надо понять детали реализации — сходить к разработчикам, понять, что они реализовали, и каким образом эта функциональность работает. Если разработчики еще не реализовали, то идти к продактам, которые развивают данную часть продукта, и узнавать, что они задумывали и сделали. Все это нужно оформить и защитить перед заказчиком, иногда вплоть до демонстрации кода продукта.
Наша аудитория — лидеры бизнеса и политики, чиновники, десятки тысяч горожан.
День технического специалиста на PulpFor 2023
5-6 апреля 2024 года в Москве состоится 1-я Международная конференция технических писателей – TechWriter Days. Опыт работы в аналогичной должности (или инженером – электроником) от одного года. Новости дня читайте на Взгляде. Вторая часть Дня технического творчества проходила на базе СПДС «Иволга», где участники трансляции посетили Хобби-клуб для родителей «Успех». 5-6 апреля в Москве состоится 1-я Международная конференция технических писателей TechWriter Days. Должность: технический писатель, хотя в последнее время скорее knowledge manager.
Всемирный день писателя – 3 марта!
| Работа технического писателя в IT-компании: цели, зоны роста, кому подходит — Карьера на | Известный нижегородский писатель Валерий Шамшурин так сказал о нем. |
| День писателя | Технический писатель рассказывает о своём рабочем дне, объясняет, что это за профессия, какие инструменты применяются и какие навыки нужны. |
Текста больше, чем кода
- Конференции для технических писателей - мероприятия для техписов на 2024 год | Документерра
- Регулярные расходы
- Февральская встреча Сообщества технических писателей Санкт-Петербурга
- День из жизни технического писателя.
- Новости дня – «ВЗГЛЯД.РУ»
Выставка к 100-летию писателя Виктора Астафьева
| Официальный сайт МБУК ЦБС | найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. |
| День писателя | SQA ANALYST TECHWRITER DAYSСмотреть онлайн - Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей. |
День технического специалиста на PulpFor 2023
Вот такой стандартный набор. Первым делом проверяю рабочую почту, потом планирую фронт работ. Вчера ночью пришли новые идеи, записываю их в блокнот, идеи здравые и требуют воплощения на бумаге. Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence.
Сегодняшний день будет полностью посвящен архитектуре нашего продукта. Описание архитектуры требует отличного знания как OpenStack, так и наших модулей, сервисов и т. В планах разобрать по косточкам neutron и, если успею, — glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта.
Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание.
Олег Рябов - писатель, главный редактор журнала "Нижний Новгород", член союза писателей России: «Я пишу всегда утром, встаю рано, в 5-6, и вот 2-3 часа для меня наиболее плодотворные, очень долго входишь в канву, в тему, в тело того текста, который был написан в предыдущие дни и недели. Читаешь, что-то какие то запятые там исправляешь, меняешь абзацы какие-то и вот когда туда уже полностью входишь, вдруг начинает вырисовываться что же будет дальше». Первые тексты, вспоминает Олег Рябов, писал на чистом энтузиазме. Сейчас он уверен - писательство — занятие для личности зрелой, уже нажившей определенный опыт. В своих книгах и стихах Олег выделяет несколько основных тем, но главная — тема Родины.
Кошка тоже считаешь, что давно пора опять есть и составляет мне приятную компанию: 12. Завтрак поглощен, посуда помыта, кошка довольна, время: 13. До выхода из дома осталось чуть меньше двух часов, надо срочно позаниматься за фортепиано, а погодка кстати налаживается, выглядывает солнышко. Может быть, синоптики обманули нас с дождем? Позанималась вполне продуктивно, выучила 4 такта, которые никак не получались три дня подряд. Кошечка считает что ей тоже нужно заниматься, при чем срочно! Иначе кого-то покусают. Гимнастика с красной ленточкой: 15.
После утомительных упражнений, я желаю кошке хорошенько выспаться и отдохнуть, она мне тоже желает не перетрудиться: 16. Пора выходить на работу. Время: 17. На бегу включаю плеер, самое время послушать Рахманинова! Выхожу из подъезда, а дорогу мне перебегает черный котейка. Но я не верю в плохие приметы, к тому же у него белые пятнышки! Я подумала, что это хороший знак и меня ждет отличный день 19. Покупаю билет на электричку: 20.
Смотрю расписание, а сзади меня уже крадется поезд: 21.
Технический день в модельной библиотеке им. Салтыкова-Щедрина перенесен на 22 февраля 17 февраля 2022 Уважаемые читатели!
В феврале в модельной библиотеке им.
: техническим писателем ✒
TechWriter Days прошла 5-6 апреля 2024 в енция организована с целью собрать и объединить специалистов, занимающихся технической документацией. Поэтому какое-то время мечтала стать писателем. В этот четверг (25.11) в 18-00 пройдет презентация профессии технический писатель и команды технических писателей Orion Innovation. девушка при исполнении, а в свободное время - поэт. Конференции для технических писателей играют важную роль в профессиональном развитии и успехе в этой области. Дневник писателя Ф. М. Достоевского.
Why should I participate?
- Новости в России и мире - ТАСС
- О мероприятии
- #Кем стать: Техническим писателем
- День рождения инженера и писателя-фантаста
- Новости по теме