Туториал — это особый тип документации, основной целью которого является помощь на самом начальном этапе работы с любым программным обеспечением, функционалом или другими видами цифровых и нецифровых продуктов.
Туториалы могут быть представлены в разных формах и форматах (печатные, созданные в виде цифровых документов или записанные в виде видео или аудио). Таким образом, у каждого есть возможность работать с ними, независимо от обстоятельств.
Что касается документации, то туториал представляет собой пошаговую инструкцию, созданную для того, чтобы помочь пользователю освоить первый уровень продукта.
Какова цель туториала?
Как можно понять из предыдущего описания, основная цель туториала — предоставить пользователю «руководство» о том, как использовать основную функциональность цифрового или другого продукта. Это достигается с помощью пошаговых инструкций, которые описывают эти шаги и объясняют работу продукта.
Бизнес широко использует туториалы как для конечных пользователей своего продукта или услуги, так и для рабочих команд. Такие инструкции позволяют понять механизмы и программное обеспечение, с которым будет работать команда разработчиков. Они также полезны для дальнейшего развития продукта, поскольку члены команды могут легко вспомнить функциональность, а новые участники могут быстро освоить основы работы.
Из-за важности данного этапа для рабочего процесса компании часто нанимают технических писателей — людей, отвечающих за написание всей документации, включая туториалы и инструкции. Поэтому этот тип документации имеет свои специфические правила написания.
Характеристики правильного туториала
Как было сказано, технические писатели — это люди, отвечающие за создание туториалов, и их работа требует соблюдения некоторых стандартов. Эти стандарты могут быть описаны в так называемых руководствах по документации, специально созданных для технических писателей, чтобы избежать ошибок при написании любой документации. Вот несколько советов, которые необходимо учитывать при написании:
- Хороший туториал должен быть структурирован. Очевидно, что каждая инструкция подразумевает строгую последовательность шагов; если её нет, это уже не инструкция. Эту последовательность нельзя нарушать или перемешивать.
- Хороший туториал должен содержать короткие объяснения выполняемых шагов. Всегда лучше не только давать информацию, но и объяснять, почему это так. Это важная часть любого обучения, особенно когда речь идет об освоении сложного программного обеспечения или продукта, особенно для людей, которые будут работать с ним на ежедневной основе.
- Хороший туториал не должен быть слишком длинным. Писатель должен помнить, что его задача — дать инструкцию по выполнению базовых действий. Нет необходимости углубляться в очень специфические особенности, которые пользователю вряд ли понадобятся на первых этапах, а только могут запутать.
Как создать туториал?
Учитывая все вышесказанное, вот несколько советов, которые помогут создать действительно хороший туториал:
- Всегда помните, что вы создаете инструкцию для людей, которые вряд ли сталкивались с продуктом ранее, поэтому старайтесь использовать как можно более простой язык, избегая технических терминов, если это возможно.
- Ваш туториал должен быть универсальным и повторяемым, чтобы пользователь мог повторить все, что он/она узнал.
- Убедитесь, что каждый описанный вами шаг работает так, как вы сказали. В противном случае пользователь будет в замешательстве и не найдет решение своей проблемы.
Другие советы будут зависеть от специфики и целей туториала, но эти пункты являются основой любой документации такого рода.