Всем привет, меня зовут Мишинёва Екатерина, я – ведущий технический писатель с опытом работы в сфере IT более 10 лет.

Сегодня я решила написать, как мне кажется, достаточно полезный пост, который будет интересен не только начинающим техническим писателям, но и опытные коллеги смогут для себя почерпнуть что-то новое.

Краткое содержание

В этом посте я хочу затронуть три взаимосвязанных ситуации, с которыми сталкивается каждый технический писатель (в итоге я назвала для себя этот пост – чек-поинт пост):

1. Как быстро влиться в новый проект?

2. Как быстро переключаться между разными проектами?

3. Как эффективно организовать для хранение документации?

Как быстро влиться в новый проект?

Основываясь на собственном опыте, я вывела для себя следующие чек-поинты:

1. Для начала необходимо изучить главные цели проекта: ознакомиться с ТЗ, инструкциями, самой системой (при наличии уже разработанной части) и другой информацией, которая поможет понять, чего нужно достичь с помощью будущей технической документации.

2. Выяснить, для кого будет предназначаться документация: необходимо определить целевую аудиторию - внешние пользователи, разработчики, сотрудники компании. Это поможет правильно адаптировать стиль и тон письма, чтобы оно соответствовало потребностям и знаниям пользователя документации.

3. Изучить существующие материалы: прочитать предыдущие технические документы, чтобы лучше понять текущий контекст и стиль письма, которого придерживаются в компании. Это позволит гармонично вписать свою работу в уже существующие материалы.

4. Наладить взаимодействие с командой проекта: необходимо организовывать встречи и общаться участниками команды (аналитики, разработчики, руководитель проект и др.). Я считаю, что нужно задавать как можно больше вопросов, чтобы получить больше информации и уточнить детали, которые помогут создать более точную техническую документацию.

5. Разработать структуру документа: сформулировать основные разделы и подразделы своего документа, это поможет упорядочить информацию и создать логичную структуру. Если документ необходимо разработать в соответствии с ГОСТ, базовую структуру необходимо взять из него и при необходимости адаптировать под требования в компании.

6. Выбрать стиль и формат документа: не мало важно определиться со стилем и форматом документа. Если в компании на момент вашей работы уже имеются свои ЛНД или просто утвержденные шаблоны оформления документов, то используйте их в своей работе и не тратьте время на изобретение нового велосипеда. Если же шаблонов нет - необходимо будет разработать и согласовать свой стиль.

Этот перечень достаточно универсальный и подойдет не только для технического писателя ;)

Как быстро переключаться между разными проектами?

Допустим у вас на работе сложилась такая ситуация или вы вошли в нее добровольно :D, и вам в течение дня приходится переключаться между проектами, которые никак не связаны между собой, то есть суть, контекст и статус совершенно разные. На такой случай по прошествии времени и опыта я вывела для себя следующие пункты:

1. Использование эффективных инструментов для организации работы: электронные таблицы и другие инструменты для отслеживания и планирования задач. Это поможет организовать работу и быстро переключаться между проектами.

2. Установка приоритетов: необходимо определить, какие проекты и задачи требуют немедленного внимания, а какие могут быть перенесены на попозже. Тут я бы еще могла предложить делегирование, но оно не всегда применимо, так как у всех есть свои задачи и вряд ли кто то будет брать на себя лишнее)) Но все-такие советую не пренебрегать этим, просите помощи, если работы слишком много.

3. Создание шаблонов и стандартов: разработайте себе шаблоны и стандарты для разных типов технических документов для упрощения процесса создания. Это позволит быстро адаптироваться к новым проектам, соблюдая установленные стандарты. Я рекомендую иметь у себя в запасе несколько подготовленных по ГОСТ документов, чтобы потом их эффективно использовать в работе и не тратить каждый раз время на одно и то же.

4. Организация хранения документации: создайте себе удобную систему хранения и упорядочивания документации и заметок для быстрого доступа к нужной информации при возвращении к предыдущим проектам. Существует много разных инструментов, про которые я кратко расскажу разделе ниже.

5. Уделяйте время переключению: планируйте время на переключение между проектами для концентрации на новой задаче и выхода из контекста предыдущего проекта, закрывая все ненужные приложения и вкладки для избегания отвлечений. Конечно, в половине случаев бывает, что над разными проектами приходится работать одновременно и переключаться тогда придется одновременно, но это уже, как говорится, на любителя и тип темперамента)))

6. Учитесь у других: общайтесь с коллегами, изучайте успешные практики и делитесь своими знаниями, чтобы постоянно совершенствоваться и повышать свою эффективность.

Как эффективно организовать для хранение документации?

Для технических писателей (да и не только) существует разные инструменты, которые помогут хранить и организовывать рабочую документацию. Вот несколько из них:

1. Документационные системы, такие инструменты, как Яндекс Cloud (инструмент wiki), Confluence, MadCap Flare или DITA (Darwin Information Typing Architecture), предоставляют возможность создания и организации технической документации в структурированном формате. Они позволяют создавать разделы, вложенные статьи, индексы и поиск, чтобы облегчить навигацию и доступ к информации. Обычно эти инструменты используются как корпоративные инструменты, для индивидуального использования редко можно встретить.

2. Облачные хранилища, такие как Яндекс.Диск, Google Drive, Dropbox или OneDrive предоставляют возможность хранить и организовывать документацию в различных форматах, таких как Word, PDF, HTML и других. Там можно создавать папки, подпапки и метки для категоризации и быстрого поиска документов.

3. Проектные менеджеры задач, такие как Trello, например, хотя в первую очередь предназначены для управления проектами, могут быть использованы для организации задач и сроков выполнения, связанных с технической документацией. Для создания простых списков задач, как мне кажется, удобно использовать Google Задачи, Google Keep, Яндекс.Заметки или даже самые обычные заметки в телефоне (на айфоне достаточно удобно).

4. Системы управления знаниями: инструменты, такие как Notion, например, позволяет организовывать информацию в виде заметок, ссылок, изображений и других элементов. Вы можете создавать категории, теги и связи между знаниями для быстрого доступа и поиска. Notion достаточно интересный и сложный инструмент, в котором стоит разобраться, хотя бы для кругозора.

Для себя я вывела вот такое комбо - OneDrive и заметки в айфоне, мне позволяет это иметь быстрый доступ ко всей моей документации с прошлых проектов и к текущим проектам, а заметки позволяют ничего не забыть. Скажу так – излишне нагружать себя еще и технологиями по управлению своей работой тоже не стоит, а то силы уйдут совсем не в то русло :)

В заключении поста скажу, что выбор инструментов и подходов к организации совей работы всегда зависит от ваших предпочтений и потребностей. Я рекомендую проводить тестирование нескольких инструментов и подходов, чтобы определить, какой лучше всего подходит для вашего рабочего процесса.