Главной целью для технического писателя является объяснить пользователю, как обращаться с приборами или компьютерными программами доступным и понятным языком.
Зачем нужны технические писатели
Кто такие технические писатели и зачем они нужны в команде Кто такие технические писатели и зачем они нужны в команде 07 июля 2021 Статьи Когда IT-продукт готов, нужно сделать так, чтобы им было удобно пользоваться — специалистам, которые будут его поддерживать, вносить в него изменения и пользователя. Для этого нужна техническая документация — она дает ответы на часто задаваемые вопросы и позволяет не тратить лишнего времени на поиск нужной информации. Технические писатели и есть те люди, кто раскладывает всю эту информацию по полочкам. Главная задача технического писателя — четко и понятно донести до пользователя информацию в виде инструкции об особенностях работы программы, ее основных функциях, проблемах, которые могут возникнуть. Такого рода инструкции как правило читают: инженеры, которые поддерживают программы или дорабатывают их; пользователи разного уровня подготовки, для которых эти программы и создаются. Инженеру может быть непонятно, как именно работает код, почему систематизация данных происходит именно по предложенным алгоритмам и как автоматизирован процесс. Обычным пользователям может быть трудно разобраться с последовательностью действий, понять, можно ли отменить операцию и как это сделать, как настроить быстрый доступ к самым нужным функциям, какие кнопки для этого созданы. Инженеры найдут ответы в сопровождающей технической документации, пользователи посмотрят инструкцию, написанную к программе, или зайдут в раздел «Помощь» или FAQ. Часто люди обращаются к инструкциям только тогда, когда становится совсем непонятно или что-то идет не так. Хорошо, если это произойдет до того, как что-нибудь будет сломано, иначе скажут — продукт плохой. Технический писатель должен предусмотреть такие ситуации: предупредить о возможной поломке, описать ее, предложить решение.
Что делает технический писатель Профессиональные знания, умения и навыки технических писателей конкретизированы и уточнены сообразно отраслевой и профессиональной специфике в Профстандарте технического писателя. Проекты разные, и набор того, что и для кого задокументировать, не всегда одинаковый. Одному проекту достаточно подробной инструкции для технических специалистов, другим потребуется пакет документов и для поддержки, и для обычных пользователей. Технические тексты считаются хорошими, если написаны точно, последовательно, но при этом кратко и понятно. В таких текстах важно, чтобы информация была структурированной, чтобы в них были списки, таблицы, схемы. Часто именно небольшой список помогает пользователю быстрее, чем длинное описание на двадцати страницах. В технических текстах обычно много иллюстраций, скриншотов интерфейсов, видео. Это нужно, чтобы человек сравнил картинку на инструкции с тем, что видит на мониторе, понял, что действует правильно, и настроил систему по шагам на картинках «В моей работе главное ориентироваться на конечного потребителя: как с помощью технической документации он будет решать свои задачи, какой у него уровень подготовки и насколько подробно все должно быть заложено в инструкции. К примеру, я сейчас работаю над частью внутренней информационной системой, которой будут пользоваться технические специалисты. Поэтому основные требования — подробная и длинная инструкция с множеством скриншотов и примеров, которые позволят пользователю решить разные задачи.
А в другом проекте я пишу небольшую часть документации по функциональности продукта для обычных пользователей. Здесь тексты простые, информативные и доступные. Моя основная задача — сделать так, чтобы и системный администратор, и обычный пользователь нашли в инструкции то что ищут и этот поиск не занял много ресурсов». Приступая к написанию любой инструкции, технический писатель анализирует многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Самый главный источник — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. Технический проект — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях.
Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.
Но значит то, что за ним не надо проверять. Он знает, как добыть информацию, к кому пойти по тому или иному вопросу и знает срок, к которому все должно быть сделано, а также в каком объеме и качестве.
Senior — это уже расширенные компетенции и нечто большее, чем все функциональные обязанности специалиста Middle. Это «большее» может быть с точки зрения, например, управленца — то есть человек, который ставит задачи нескольким мидлам. Или человек, который глубоко знает определенную предметную область или систему. Поэтому специалист может вырасти до ведущего технического писателя, в подчинении которого находится несколько специалистов, затем — в руководителя подразделения технической документации. Кому подходит карьера технического писателя Главное качество, которое отличает технического писателя — это ответственность. Потому что мы работаем с формальным треком, который с крупным заказчиком проходит через его внутренний электронный документооборот, сопроводительные бумаги и письма. Поэтому невозможно физически договориться о том, что мы сегодня не успели и сделаем завтра. Если срок сдачи документа — 30 сентября, то не позднее этого дня он должен быть любой ценой.
Но при этом вариативность типа личности, которому подходит карьера технического писателя, велика. Есть люди, которые целый день проводят в переговорах, обсуждении договоренностей и планов. А есть те, кто сидит и разбирается в функциональности продукта, выясняет, что за полгода сделали разработчики. Именно от специфики проекта зависит тот склад ума и характера человека, который под него подходит. Предположим, в компании открыто несколько вакансий технических писателей на разные проекты. Давайте смоделируем несколько ситуаций: проектов и подходящих под них типажей кандидатов. Типаж 1 — «библиотечный бука» Есть проект А, на котором приходится писать сложные документы. Например, пояснительную записку на 1000 страниц с техническими подробностями.
Человек, который подходит под этот проект, может быть не очень коммуникабельным, но должен быть своеобразным «библиотечным букой»: зарыться в техническую информацию и сидеть с ней разбираться, выстраивая из этого стройный текст. Типаж 2 — «решала» Проект Б. На проекте много согласующих, но несложная документация. Не требуется глубоко лезть в технические вещи. На этом проекте, чтобы согласовать небольшую стопку документов, нужно встретиться с заказчиками и с 5-6 людьми договориться, понять, что они хотят, найти к каждому подход. Поэтому на этот проект нужен своеобразный «решала» — человек, который умеет договариваться, нравиться людям и находить компромиссы. Типаж 3 — «бодала» Проект В. На этом проекте непростое согласование документов, потому что со стороны заказчика есть люди, у которых свое представление о прекрасном.
Нет широкого поля для коммуникаций, нет глобальных технических сложностей, но тут, находясь в одной связке с заказчиком, надо уметь отстаивать свои интересы. Человек, работающий на этом проекте, должен уметь работать в одной команде с заказчиком, но при этом «бодаться» — защищать свое мнение. Выводы Технический писатель в IT — это полноценный член проектной команды. Он взаимодействует со всеми участниками и напрямую отвечает за успех проекта. У технического писателя есть конкретные зоны роста, помимо создания технической документации — это менеджмент, аналитика и юриспруденция. Технический писатель может расти как горизонтально, так и горизонтально-вертикально, так и вертикально.
День рождения инженера и писателя-фантаста 02.
Фото: РИА Новости 01. Фото: РИА Новости 189204 0 117 лет назад, 2 сентября 1906 года, в Акмолинске сегодня — Астана, столица Казахстана родился изобретатель, писатель-фантаст Александр Казанцев. После окончания Томского технологического института он работал инженером-механиком, но увлекшись изобретательством, перешел работать во Всесоюзный научно-исследовательский институт электромеханики. Когда Александру Казанцеву было 35 лет, началась Великая Отечественная война. В армии он служил заместителем командира саперного батальона, причем в звании рядового.
Поэтому основные требования — подробная и длинная инструкция с множеством скриншотов и примеров, которые позволят пользователю решить разные задачи. А в другом проекте я пишу небольшую часть документации по функциональности продукта для обычных пользователей. Здесь тексты простые, информативные и доступные. Моя основная задача — сделать так, чтобы и системный администратор, и обычный пользователь нашли в инструкции то что ищут и этот поиск не занял много ресурсов». Приступая к написанию любой инструкции, технический писатель анализирует многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Самый главный источник — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. Технический проект — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП: что-то не учли, что-то поняли неправильно, что-то оптимизировали. Для того, чтобы узнать, как на самом деле всё было реализовано, используется техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы. Этот источник незаменим для написания руководств по настройке. Технический проект, техническое описание и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Процесс работы технического писателя. Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача технического писателя — определить, реальна ли проблема и в каком формате её нужно решать. Вот как строится процесс работы: Определение главных задач документации и ее аудиторию. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик. Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров. Поиск и подготовка иллюстрации к тексту. Наполнение документа текстами и отправка его на проверку экспертам. Внесение правок от разработчиков и экспертов. Презентация документации заказчику. Передача документации команде. Этапы не должны затягиваться.
Выставка к 100-летию писателя Виктора Астафьева
| Февральская встреча Сообщества технических писателей Санкт-Петербурга | Опыт подготовки технической документации (ГОСТ 19, ГОСТ 34); - Хороший уровень владения русским языком, грамотная письменная речь; - Умение структурировать и систематизировать информацию. |
| Лента новостей - РТ на русском | Должность: технический писатель, хотя в последнее время скорее knowledge manager. |
| День из жизни технического писателя. | День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. |
НОВОСТИ ДНЯ
Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации. Мы ищем технического писателя в команду Indeed Access Manager. День материализации мужчины-технического писателя отменен из-за возможных недоразумений и неправильного использования. Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля.
Информация
- Подпишитесь на рассылку
- Кто такие технические писатели и зачем они нужны в команде - Центр оценки и кадрового развития
- ВДНХ и городские библиотеки приглашают 3 марта на День писателя
- Новости Самары - главные новости сегодня | 63.ру - новости Самары
Наука и техника
День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев. Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно. В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. День рождения инженера и писателя-фантаста 01.03.1981 Писатель-фантаст Александр Казанцев.
Новости дня
Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера. Большую часть дня, исключая беседы и различные семинары, технический писатель посвящает себя работе за компьютером.
День технического перевода
Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы. Выходили и специальные выпуски, посвященные очередному съезду КПСС, выборам, праздничным датам, торжественным похоронам видных государственных и политических деятелей. С 1984 года журнал поменял своё название на «Хроника наших дней» изменились заставка и музыка журнала.
Коллеги, наступил февраль, а с ним и День технического писателя — 2 февраля. Приглашаем вас встретиться в SEMrush и поздравить друг друга 10 февраля, в пятницу. Перерыв у вас будет возможность получить рекомендации по профессиональному развитию, поделиться своими проблемами, обсудить ситуацию на трудовом рынке и поспорить о роли писателей в меняющемся мире IT Круглый стол "Документация и справка мобильных приложений" с 20 ч. Мы обсудим вопросы: Какие новые термины из области мобильной разработки должен знать техрайтер? Необходимо ли техническое задание на мобильное приложение?
Всемирный день писателя — 3 марта! Писатели — люди, которые создают художественные литературные произведения разных жанров, предназначенные для широкой аудитории читателей. Чтобы стать востребованными и заполучить любовь читателей, идеи произведений должны быть актуальными и интересными Интересные факты об известных писателях: Настоящее имя Корнея Чуковского — Николай Васильевич Корнейчуков. При рождении он получил фамилию матери, но с первой же статьи стал подписываться псевдонимом Корней Чуковский.
Чтобы не пропустить интересные и познавательные события 3 марта, за анонсами можно следить в разделе «Афиша» на портале mos. Кроме того, информация будет публиковаться на официальных сайтах библиотек. Культурный центр «Содружество» Рижский проезд, д. Юным гостям расскажут о жизни и творчестве Александра Пушкина и Корнея Чуковского. Всем гостям вместе с ведущими предстоит прочесть «Сказку о рыбаке и рыбке». В конце встречи ребят ждут познавательные игры. Им зададут вопросы по классическим и современным произведениям. Это поможет ребятам вспомнить знаменитые русские сказки, повести и рассказы. Здесь пройдет занятие «С книгой назначена встреча…». Детям расскажут интересные факты из жизни русских писателей Александра Пушкина, Ивана К рылова, Аркад ия Гайдара, чьи ю билейные даты пришлись на текущий год. А еще библиотекари помогут гостям найти ответы на вопросы о том, кто такие писатели и в чем состоит их труд. Еще для ребят проведут конкурсы, в которых они смогут проявить свою эрудицию, начитанность и смекалку. Начало в 11:00. Здесь будет организована праздничная программа, которая начнется в 14:00. Помимо этого, школьники расскажут о своем любимом авторе и произведениях, которые их впечатлили больше всего. Халтуринская, д. Он будет посвящен 220-летию со дня рождения писательницы и историка Александры Ишимовой.
Подпишитесь на рассылку
- Всемирный день писателя | Отрадненский нефтяной техникум
- Краткий обзорный ролик TechWriter Days - Первой Международной конференции технических писателей
- День технического перевода
- Один день технического писателя
- День писателя
Февральская встреча Сообщества технических писателей Санкт-Петербурга
Companies that provide tools and technologies for creating and managing technical documentation can use the conference to promote their products and connect with potential customers. Why should I participate? Communication Two days of intensive work with colleagues, you will be able to discover new solutions to the challenges facing you and your company. Experience You can familiarize yourself with best practices and personally discuss the details that interest you with independent experts and representatives of leading IT companies.
Networking Informal interactions will provide you with information about the effectiveness and feasibility of specific solutions your company plans to use. Discussions Participating in roundtable discussions and debates will enable you to view aspects of technical documentation from different perspectives, uncovering new possibilities for effective work. Contacts New connections will help you tap into the vast experience of top experts in the field of technical documentation.
Learning A unique opportunity for learning and participation in workshops will allow you to enhance the quality of your work. Change of Environment Working in a new setting will enable you to look at technical documentation development issues in a fresh light and make the most efficient use of your time for company development. WiFi High-speed internet will allow you to perform real-time production tasks, even while attending presentations.
For your convenience, a template letter for your management justifying your participation in the conference is provided below. Gaining New Knowledge and Best Practices.
В основу легли воспоминания, впечаления о путешествиях, размышления о людях, философские вопросы, пейзажи. Затеси очень разные по своему содержанию и объему, порой это всего несколько абзацев. Сам автор дает такое определение: «Затесь — сама по себе вещь древняя и всем ведомая — это стёс, сделанный на дереве топором или другим каким острым предметом. Делали его первопроходцы и таежники для того, чтобы белеющая на стволе дерева мета была видна издалека, и ходили по тайге от меты к мете, часто здесь получалась тропа, затем и дорога, и где-то в конце ее возникало зимовье, заимка, затем село и город». На выставке представлено первое издание «Затесей» 1972 года.
Всего писатель создал свыше двухсот художественных произведений, которые издавались более ста раз почти в тридцати странах. Экспозиция состоит из пяти разделов, каждый из которых носит название географических мест, где жил и работал писатель. Они были не только частью биографии Астафьева, но и неизменно присутствовали в его произведениях. Раздел «Игарские затеси» рассказывает о детских годах жизни драматурга и его трудах, в которых описывается заполярный город Игарка.
Они были не только частью биографии Астафьева, но и неизменно присутствовали в его произведениях. Раздел «Игарские затеси» рассказывает о детских годах жизни драматурга и его трудах, в которых описывается заполярный город Игарка. Интерес представляет уникальное издание «Игарские затеси» Валентины Гапеенко. В нем можно найти первую публикацию о литературном творчестве школьника Виктора Астафьева в газете «Большевик Заполярья» 1939 г. Представлено одно из первых произведений писателя «Васюткино озеро». Автор книги также приводит переписку Астафьева с игарчанами. Основная часть фотоматериалов взята из фондов писателя и Красноярского краевого краеведческого музея. Особое место в творчестве Виктора Астафьева занимала Великая Отечественная война. На фронт он пошел добровольцем, служил шофером, артиллеристом, разведчиком, связистом, пока в 1944 г.
Но в целом, по опыту, среди технических писателей немало лингвистов, переводчиков, журналистов — тех, кто отлично обращается со словами и нашёл подход к освоению технологий. Анастасия Клещенок руководитель группы технической документации Я работаю в небольшой команде технических писателей в Ozon. Наша команда трудится на благо одного департамента разработки. В департаменте 3 направления — у каждого свой техпис. Он помогает разработчикам со всеми типами документов. Большой плюс такой позиции — разнообразие задач. Можно побыть в роли тестировщика, если редактируешь текст новой фичи, или менеджера, если внедряешь новый процесс для команды. Мы работаем с онбордингами для новичков, статьями про сервисы и ML-модели, API, release notes, пользовательскими инструкциями для внутренних инструментов. Интервьируем держателей знаний и пишем с нуля, доводим до готовых статей черновики разработчиков, вычитываем статьи коллег, помогаем оформлять тексты для интерфейсов и автодокументации. Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе. Даже этот рассказ о себе мне сложно писать. Я отучился год на журфаке, а потом перешел в вышку на менеджмент. Оба образования мне пригодились, потому что со временем я стал лидом. В работе техписа мне нравится упорядочивание — из страшного сумбурного текста делать стройный и понятный. Кроме того, сейчас я параллельно выступаю как бизнес- аналитик для небольшой команды разработки. Опыт техписа там тоже пригодился, потому что приходится много писать требования и другую проектную доку.
Конференции: полезный ресурс для технических писателей
Источник: wildberries. Все забрала. Обратно еду на такси, не хочу таскаться в обнимку с подушкой и одеялом. Сокрушаюсь, что мобила фотографирует так себе, но что делать, за неимением гербовой пишем на клозетной 15:30. Закидываю все в квартиру и обнаруживаю, что чайника в ней тоже нет. Что ж, опять иду в хозяйственный. Чайник по дороге пытался упрыгать: порвалась коробка. Но вроде живой.
Бобик сдох. Кидаю на кровать привезенный с собой лоскутный плед, валяюсь. А нет, уже не валяюсь. За неимением рулетки меряю кровать собой и заказываю в ближайший на этот раз пункт «Вайлдберриз» новое постельное белье. И привычное средство для стирки без запаха. И еще одну подушку, потому что имеющаяся какая-то не очень. Кроме пледа, чтобы на новом месте было уютнее, я взяла с собой фигурку, которую сын подарил на день рождения, записку с рисунком от дочки и кольцо, которое муж распечатал на 3D-принтере.
Располагаюсь на кухне с виноградом и ноутбуком. Читаю «Реддит», болтаю в «Телеге» и «Дискорде». Обнаруживаю, что окна квартиры выходят на запад. Неожиданно, но приятно 18:30. Пишет коллега — они в соседнем доме, предлагает завтра погулять. Всегда за! Свежекупленный чайник пахнет пластиком, нормальный куплю потом, а пока попытаюсь привести в чувство имеющийся.
Добавим к этому кризис шоколадных сырков и мандаринов, случайно моргнем и получим доставку «Рядом» — это типа российского «Самоката». Конина, впрочем, очень вкусная, я в первый же день попробовала. Ужасно болит голова. Точно помню, что брала с собой таблетки, но никак не могу их найти. Злюсь и выкидываю все из рюкзака. Сколько же го… ловокружительно разных вещей там валяется. Таблетки нашлись в кармане, о существовании которого я вообще не подозревала.
О сколько нам открытий чудных готовят просвещенья дух. Сейчас бы полежать с котиком: у меня острый недокотин — но котики в Питере. И муж в Питере. И дети в Питере. И друзья в Питере. Очень не хватает семьи, друзей и кошек. Ну и в целом ощущения Питера кругом, я его очень люблю.
Закажу-ка еще кухонных и банных полотенец и займусь вонючим чайником, а то с такими мыслями далеко зайти можно. Спойлер: избавиться от запаха так и не удалось, купила новый чайник. Наконец-то происходит ничего. Давно пора. Читаю «Реддит», ем мандарины и сырок — сегодня день сырка, треплюсь в «Телеграме». На кухне, кстати, уютно, пожалуй, назначу ее пока рабочим местом. В один из чатов скидывают ссылку на курс по аналитике, над которым я думала, — на него скидка.
Демонстрировался в кинотеатрах перед киносеансами. Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы.
Отображение сетевого контента Отображение сетевого контента 5 июля 2023 года - 120 лет со дня рождения писателя Владимира Григорьевича Сутеева 06. Один из зачинателей отечественной мультипликации. В 1924-м году Владимир поступил в Государственный Техникум Кинематографии, где обучался на художественном факультете.
Интересно, что вместе с Сутеевым учился его двоюродный бат Дмитрий Боголепов , ставший в дальнейшем известным режиссером.
В неё добавляются новые функциональные возможности, старые отмирают или видоизменяются. Настройка системы становится всё сложнее, в интерфейсе появляется всё больше параметров, которые взаимодействуют друг с другом неочевидным и зачастую непредсказуемым образом. Постоянная гонка за быстрой реализацией новых бизнес-возможностей приводит к тому, что сокращается время на рефакторинг старого кода и устаревших интерфейсов.
Так и остаются в системе старые и недействующие параметры и настройки. Представьте, каково пользователям работать в такой «пожилой» системе без сопроводительной документации, которую пишут технические писатели. Это всё равно, что управлять атомным реактором, не прочитав предварительно многотомное руководство по интерфейсу пульта управления. Как говорил Гомер Симпсон: «На такую-то кнопку так сразу и не нажмёшь».
Внутренние документы по системе, порождённые в процессе разработки, представляют для пользователя неразрешимую головоломку. Без пользовательской документации он просто «утонет» в многочисленных описаниях итерационных изменений, выполненных в различных местах системы. Задача технического писателя — всё это объединить, систематизировать, структурировать и изложить понятным пользователю стандартизированным языком. Кстати, бывает, что аналитики, разработчики и тестировщики сами с трудом ориентируются во внутренней документации.
Чтобы быстро найти ответ на свой вопрос они часто пользуются документацией, написанной техническими писателями. Ведь там всё аккуратно разложено по полочкам, структурировано и систематизировано. Нажми на кнопку — получишь непонятный результат «Клавиша имитации ручки выполняет переключение из исходного меню в меню ручек управления, которое позволяет выполнить функции ручек управления с помощью клавиши». Техническим писателям часто приходится описывать поля в окнах приложений.
Обычно это списки из пар «Название поля — описание». Если нам нечего добавить к названию поля, мы понимаем, что интерфейс спроектирован хорошо, а логика работы системы проста и понятна. Это характерный показатель того, что название поля полностью описывает его назначение и никаких исключений и особенностей в его работе нет. Но, к сожалению, так бывает редко.
Чаще нам встречаются объекты с непонятным названием и назначением. Сколько раз мне приходилось описывать поля с названием «Дата начала» или просто «Дата»! Вот признаки плохого интерфейса, которые сразу видны техническому писателю: объекты с непонятным назначением, с невнятным названием или вовсе без названия; неочевидные и скрытые возможности интерфейса, о которых пользователь не может узнать без чтения документации; большое количество кнопок с непонятными пиктограммами, без описания и всплывающих подсказок. Мне приходилось описывать интерфейсы, в которых на одной панели рядом было расположено несколько кнопок с одинаковыми пиктограммами и разным назначением.
Но даже если интерфейс спроектирован хорошо и качественно, в сложных системах всё равно будет требоваться его описание. Хотя бы для того, чтобы внятно объяснить пользователю, почему ему недоступно для редактирования то или иное поле. Или чтобы составить списки доступности просмотра и редактирования полей в зависимости от роли пользователя.
«День с писателем».
Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов. Для всех участников процесса разработки главное — не забыть создать задачу, ведь писатели должны откуда-то узнать о том, что что-то нужно задокументировать. К сожалению, у нас всё ещё бывают такие ситуации, когда подходит срок отгрузки новой системы, а заявка на документирование этой системы не создана. В этом случае чуда не произойдёт — документация не появится моментально. Внутренняя «кухня» — источники вдохновения Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много.
Самый главный — это технический проект ТП , которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание ТО , которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент. Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии тест-кейсы.
Этот источник незаменим для написания руководств по настройке. ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения. Задача писателя — объединить всю полученную информацию и написать простую, понятную и хорошо структурированную документацию о системе или решении. Тут нужно быть очень внимательным — ничего не перепутать, не забыть, описать именно то, что было реализовано. Писатель должен самостоятельно разобраться во всех особенностях реализации, понять все алгоритмы и принципы работы системы от начала и до конца. Только так получится хорошая и качественная документация. Один в поле не воин Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками.
Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают.
Я так встаю НЕ каждый день, но несколько раз в неделю бывает 2. Первое, что нужно сделать в этой жизни ранним утром - это покормить кошку. Иначе просто никак. Кошку зовут Фифа, смотреть в кадр она стесняется. Выглядываю в окно, там почему-то пасмурно, это странно, потому что вчера было безоблачно и ничего не предвещало беды.
Пью чай с мятой и съедаю микроскопический бутербродик: 5. Одновременно смотрю погоду, сегодня у меня много "уличных" планов намечается. Погода теплая, но мокрая: 6. Пора выходить на пробежку. Время: 7. Это стадион, на котором чудесное резиновое наверное покрытие, бегать одно удовольствие.
Возможно сейчас пойдет дождь, но я сильная! Я не пугаюсь 8. Срочно бегу в душ! Время: 10. Теперь можно полноценно позавтракать! Овсяная каша, огурец, помидор, хлеб и чай - радость для моего организма 11.
Попробуйте повторить операцию позднее","employerReviews. После модерации он появится на сайте Dreamjob. Отображается последний отзыв. Попросим работодателя открыть отзывы","employerReviews. Возможно, сама компания рассказала о них в вакансии — посмотрите описание.
Теперь соискатели видят 1 отзыв.
Настоящий профессор по неожиданным идеям и фантазиям. А идей и замыслов у него очень много. Недаром у этого автора вышло более ста книг! В его произведениях много юмора и доброты.