Онбординг#
Онбординг (англ. onboarding) — это процесс интеграции новых сотрудников в компанию.
Как и в любой новой команде, первые дни технического писателя могут быть трудными, но интересными. Первым делом следует ознакомиться с компанией, ее продуктами и проектами, а также понять, какие документы уже были созданы и насколько полезны они были для пользователей.
Обычно процесс онбординга технического писателя включает в себя следующие шаги:
Знакомство с командой#
Технический писатель будет работать с разными специалистами, такими как разработчики, тестировщики, аналитики, инженеры, дизайнеры, менеджеры продукта и QA-инженеры. Каждый из них может предоставить уникальную информацию, необходимую для создания документации.
Разработчики и инженеры: Они предоставляют технические детали о продукте, его функциональности и особенностях. Взаимодействие с разработчиками помогает понять сложные технические концепции и терминологию.
Дизайнеры: Сотрудничество с дизайнерами позволяет получить доступ к макетам, изображениям и графике, которые могут использоваться для визуального улучшения документов.
Менеджеры продукта: Они могут предоставить информацию о целевой аудитории, основных преимуществах продукта и его использовании в реальных сценариях.
QA-инженеры: Их обратная связь может быть ценной для выявления возможных проблем или недочетов в документации.
Технический ландшафт организации и внутренние инструменты для работы#
Важно понять, как устроен процесс разработки, каким образом коммуницируют и взаимодействуют различные члены команды, и какие инструменты используются для управления проектами и документацией.
Основные инструменты для работы в команде:
Основные инструменты для работы в команде#
Системы управления проектами (Project Management Systems):
Позволяют создавать задачи, просматривать статус выполнения проекта, распределять роли и сроки, а также отслеживать прогресс и результаты работы.
Виртуальные коммуникационные инструменты (Virtual Communication Tools):
Включают платформы для онлайн-встреч, обмена сообщениями, аудио- и видеозвонков, что помогает общаться и сотрудничать удаленно.
Системы управления версиями (Version Control Systems):
Позволяют отслеживать изменения в исходном коде или документации, управлять версиями и слиянием изменений от разных членов команды, например, Git или Bitbucket.
Постановка задач (Task Managers):
Помогают отслеживать и организовывать задачи, которые должны быть выполнены командой, а также контролировать их прогресс и статус, например, Jira.
Системы обратной связи (Feedback Systems):
Позволяют получать и оценивать обратную связь от коллег, пользователей или клиентов, что способствует улучшению работы команды и продукции.
Инструменты для онлайн-совещаний и вебинаров (Online Meeting and Webinar Tools):
Облегчают общение и проведение презентаций или обучающих сессий в режиме реального времени.
База знаний (Knowledge Base):
Предоставляет централизованное хранилище знаний, руководств и документации, доступное для всех участников команды, как правило, это Confluence – платформа для совместной работы над документацией, обмена знаний и сотрудничества.
Agile инструменты (Agile Tools):
Agile – это методология разработки, которая подразумевает итеративный и гибкий подход к управлению проектами и задачами. Включение Agile-инструментов, таких как Agile платформы управления проектами (например, Jira Software или Trello), спринт-планирование, доски задач, ретроспективы и др., позволяет команде более эффективно управлять задачами и адаптироваться к изменениям в процессе разработки продукта или выполнения проекта. Agile также способствует улучшению коммуникации, прозрачности и коллективному владению проектом.
Изучение стандартов и инструментов документирования#
Технический писатель должен первым делом изучить стандарты документирования (Style Guide) и инструменты, которые используются для разработки документации:
Руководство по стилю (Style Guide)#
Руководство по стилю (Style Guide) – это документ, который определяет и описывает стандарты, правила и рекомендации для использования стиля и форматирования при создании текстовой документации или других материалов в организации. Это может быть отдельный документ или часть корпоративного стандарта документирования, о котором упоминалось ранее.
Руководство по стилю обычно разрабатывается для того, чтобы обеспечить единообразный и консистентный внешний вид всех текстовых материалов компании, включая техническую документацию, руководства пользователя, маркетинговые материалы, веб-страницы и другие документы. Оно может включать следующие элементы:
Форматирование текста: Руководство определяет правила относительно шрифтов, размеров, выравнивания, интервалов и других параметров форматирования текста. Это обеспечивает единообразный внешний вид документации.
Заголовки и подзаголовки: Определяются стили и иерархия заголовков и подзаголовков, чтобы создать структурированность и удобство в навигации по документации.
Списки и перечисления: Устанавливаются правила для создания нумерованных и маркированных списков, что помогает улучшить читаемость документов.
Терминология и соглашения об именовании: Руководство может определить стандартную терминологию и соглашения об именовании для технических терминов, функций, кнопок и т.д.
Использование аббревиатур и сокращений: Регламентируется правила использования аббревиатур и сокращений, чтобы предотвратить недопонимание и улучшить ясность текста.
Пунктуация и грамматика: Определяются правила использования пунктуации и грамматических конструкций для обеспечения правильного понимания текста.
Изображения и графика: Если документация содержит изображения, руководство может устанавливать стандарты для их использования, размеров, разрешения и подписей.
Цвета и оформление: Если документация содержит цвета и оформление, руководство может определять стандарты для их использования и согласованности с общим брендом компании.
Руководство по стилю обычно разрабатывается командой технических писателей или специалистов по документации, а также может включать вклад от других заинтересованных сторон, таких как дизайнеры, маркетологи и менеджеры. Цель руководства по стилю – обеспечить профессиональный и согласованный внешний вид документации, что способствует улучшению качества и восприятия материалов компании.
Инструменты#
Инструменты документирования:
Текстовые редакторы: Это базовые инструменты для создания текстовой документации. Технические писатели могут использовать популярные текстовые редакторы, такие как Microsoft Word, Google Docs, или более продвинутые редакторы с поддержкой разметки, такие как Markdown редакторы.
Version Control Systems (VCS): VCS, такие как Git, позволяют управлять версиями документации, отслеживать изменения и обеспечивать совместную работу над документами в команде.
Диаграммы и схемы: Инструменты для создания диаграмм и схем, такие как Microsoft Visio, Lucidchart или draw.io, могут быть полезны для визуализации сложных процессов и структур.
Электронные таблицы: Программы, такие как Microsoft Excel или Google Sheets, могут быть использованы для организации и анализа данных, а также создания таблиц и списков.
Базы знаний и Wiki-платформы: Компании могут использовать базы знаний и Wiki-платформы, такие как Confluence, для хранения и совместного редактирования документации, руководств и инструкций.
Изучение продукта#
Технический писатель должен изучить продукт или проект, над которым работает команда. Это может быть как программное обеспечение, так и аппаратное оборудование или другие технические решения. Важно понять, как продукт функционирует, его основные характеристики и для кого он предназначен.
Изучение документации#
Технический писатель должен изучить существующую документацию, если она уже есть. Это поможет понять, что уже было сделано, и избежать дублирования работы.
База знаний#
Изучите Базу знаний продукта.
Документация конкурентов#
Изучение документации конкурентов поможет в следующем:
Понимание лучших практик: Изучение документации конкурентов позволяет узнать о лучших практиках и подходах к представлению информации. Технический писатель может узнать, какие структуры, форматы и стили наиболее эффективны для передачи информации пользователю.
Избежание повторений: Поможет избежать повторений и создать уникальную и интересную документацию, которая будет отличаться от других продуктов на рынке.
Идентификация пробелов: Анализ документации конкурентов позволяет выявить пробелы или недостатки в их материалах. Технический писатель может использовать эту информацию для того, чтобы предоставить более полную и понятную документацию своего продукта.
Сравнение функциональности: Изучение документации конкурентов поможет понять, какие функции и возможности доступны в их продуктах. Это поможет техническому писателю выделить уникальные возможности своего продукта и сосредоточиться на их демонстрации.
Инновации и развитие: Анализ документации конкурентов может вдохновить технического писателя на новые идеи и подходы к созданию документации. Это способствует инновациям и развитию в сфере технической документации.
Изучение документации конкурентов не означает копирование их материалов, а только служит для возможности создавать оригинальную и уникальную документацию, соответствующую особенностям своего продукта и потребностям своих пользователей.
Общение с разработчиками и инженерами#
Необходимо установить контакт с разработчиками и инженерами, чтобы получить первичную техническую информацию о продукте.
Изучение технологий, который использует продукт#
Технический писатель должен изучить архитектуру продукта и понять какие технологии в нем используются, как различные компоненты взаимодействуют между собой.
Изучение программного интерфейса (API)#
Если продукт предоставляет программный интерфейс для разработчиков, технический писатель должен изучить API и его функциональность. Это позволит создать документацию для разработчиков, которая поможет им успешно использовать API.
Изучить терминологию#
Технический писатель должен ознакомиться с техническими терминами и терминологией, используемой в продукте. Это поможет ему использовать правильные термины и обеспечить единообразие в документации.
Тестирование продукта#
Для полного понимания продукта, технический писатель может протестировать его на практике. Установите продукт локально или используйте его веб-версию. Тестирование поможет выявить особенности продукта, проблемы пользователей и возможные сценарии использования, что позволит создать более релевантную документацию. На этом этапе записывайте все трудные моменты, с которыми вы столкнулись при использовании продукта: при установке, при использовании, вы сейчас в роли нового пользователя продукта и вы сможете дополнить документацию, чтобы, в дальнейшем, таких трудностей не возникало.
Общение с разработчиками и инженерами#
Технический писатель должен активно общаться с разработчиками и инженерами, чтобы получить дополнительную информацию о продукте и его технологиях. Регулярные обсуждения и интервью помогут уточнить детали и получить ценные знания от экспертов.
Испытательный срок#
Продолжительность#
Как правило, испытательный срок для технического писателя 3 месяца.
Как успешно пройти испытательный срок#
Вот некоторые советы, которые помогут вам пройти испытательный срок:
Изучите продукт или технологию: Уделите время изучению продукта или технологии, с которыми вы будете работать. Понимание продукта поможет вам создавать более информативную и точную документацию.
Будьте внимательны к деталям: Точность и правильность очень важны для технической документации. Будьте внимательны к деталям и проверяйте свои тексты на ошибки.
Следуйте стандартам документирования: Если в компании есть Руководство по стилю (Style Guide), следуйте им. Это поможет создавать единообразную документацию и улучшит вашу производительность.
Общайтесь с коллегами: Сотрудничайте с разработчиками, инженерами и другими членами команды. Обсуждайте вопросы, задавайте вопросы и уточняйте детали. Взаимодействие поможет создать более полную и точную документацию.
Принимайте обратную связь: Будьте открыты к обратной связи от коллег и руководства. Учтите замечания и стремитесь улучшаться в своей работе.
Будьте организованными: Эффективное управление временем и организация работы помогут вам выполнить свои задачи в срок и с высоким качеством.
Демонстрируйте проактивность: Предлагайте инициативы и новые идеи для улучшения процесса создания документации или качества продукта.
Поддерживайте позитивное отношение: Будьте позитивным и открытым к обучению.
Улучшайте свои навыки: Продолжайте развиваться как технический писатель. Изучайте новые технологии и инструменты, улучшайте свои навыки написания и редактирования.
Испытательный срок – это возможность для вас и вашего работодателя оценить, подходите ли вы для данной роли. Постарайтесь использовать этот период максимально эффективно, чтобы продемонстрировать свои знания, навыки и профессионализм.
Постановка целей на испытательный срок#
Определите с тим-лидом свои задачи на испытательный срок. Постановка целей поможет вам иметь четкое представление о том, что от вас ожидается и что вы хотите достичь во время этого периода. Вот несколько целей, которые вы можете поставить перед собой на испытательный срок:
Изучение продукта: Целью может быть глубокое изучение продукта или технологии, с которой вы будете работать, чтобы понимать его функциональность и особенности.
Изучение инструментов документирования: Если в компании используются специальные инструменты и технологии документирования (например, docs-as-code), поставьте перед собой цель освоить и эффективно использовать их в своей работе.
Создание первичной документации: Поставьте перед собой задачу создать несколько документов или руководств, которые будут представлять вашу способность описывать сложные технические концепции простым и понятным языком.
Соблюдение стандартов: Поставьте цель создавать документацию в соответствии с установленными корпоративными стандартами и стилем.
Коллаборация с командой: Планируйте активно взаимодействовать с разработчиками, инженерами и другими членами команды для получения обратной связи и уточнения деталей.
Улучшение процесса: Поставьте цель предложить улучшения в процессе создания документации, которые могут повысить ее качество и эффективность.
Успешное завершение проектов: Если вам поручены конкретные проекты, поставьте цель успешно завершить их в рамках испытательного срока.
Важно, чтобы поставленные цели были реалистичны и измеримы. Записывайте свои цели и прогресс в их достижении. Это поможет вам держать фокус и оценивать свои успехи по истечении испытательного срока. Не бойтесь обращаться за помощью и советами у своих коллег или руководства, и помните, что испытательный срок – это время для роста и развития в новой роли.