Нет голосов.
Подождите...

Пользовательские руководства – неотделимы от программного обеспечения. Не существует ПО, где нету руководства пользователя. Конечные пользователи — это люди, которые могут подпадать под определенные категории и быть объединены понятием целевой аудитории, но, тем не менее, это все еще просто группа уникальных людей. Итак, некоторый функционал, понятен одному человеку – это ракетостроение, непонятное другому. Это доказывает два момента: Да, нам всем нужна техническая документация, чтобы наш продукт использовался надлежащим образом и, да, к этой документации следует подходить со многих точек зрения и тщательно проверять, чтобы ее понимали все.

Подходы к тестированию документации

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

Экспертное тестирование проводится людьми, которые знают продукт (в нашем случае продуктом является документация); они являются специалистами, знакомыми с предметом. Они могут провести настоящее тщательное тестирование, поскольку понимание внутренних механизмов дает им такую возможность. Хотя, есть и обратная сторона — довольно часто, почти невозможно увидеть большую картину, с которой столкнутся обычные пользователи, когда они попытаются использовать Ваше руководство.
И вот здесь играет свою роль пользовательское тестирование. Этот вид тестирования так же важен, как и первый — в конце концов, это обычные пользователи, которые решают, хороша ли документация или нет. Конечно, такое объединение экспертного обзора и пользовательского тестирования работает лучше всего.
Представим, что Ваша группа выпуска документации только что закончила новую итерацию руководства пользователя. Вот оно у Вас – тяжелый фолиант, сделанный из чистых знаний и слез технического писателя. И Вам нужно сейчас его протестировать. Но, откуда Вы начнете?

Первым делом – безопасность

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

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

Пересмотрите разделы справки, содержащие основные функциональные возможности и термины — это основа Вашего пользовательского руководства, и оно должен быть тщательным и точным.

Смысл

Второй тип проверки — это проверка связности. Всем известно, что для написания отличного руководства пользователя Вам нужен сначала план – скелет, который Вы позже расширите и заполните темами. Если Вы сделали все хорошо — проверка не будет слишком сложной. В противном случае, соберитесь с духом! У Вас есть работа.

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

Кроме того, нет никакой связности без правильной навигации. Во-первых, убедитесь в отсутствии нерабочих ссылок. Во-вторых — проверьте элементы навигации, такие как навигационные заглавия, следующая / предыдущая тематическая навигация и т. д. Если Вы не увидели много из этого всего, подумайте об этом – возможно понадобиться добавить пару для лучшего пользовательского интерфейса.

Пусть пользователи чувствуют себя как дома

Теперь, пришло время для отшлифовки. Когда все содержание готово, самое время убрать мелочи.

Большинство компаний имеют готовые руководства по стилю, разработанные дизайнерами пользовательского интерфейса, чтобы позиционировать компанию на рынке – логотип компании, корпоративная система цветов, шрифты и т.п. уже установлены. Общей практикой является создание пользовательской документации в соответствии с руководством по стилю оформления. Это также помогает при использовании руководства вручную, поскольку руководства по стилю создаются с учетом лучшего пользовательского опыта.

Кроме того, на этом этапе, должны быть проведены окончательная проверка орфографии и корректура. Опечатки и глупые ошибки могут действительно раздражать пользователя, поскольку он или она могут быть уже не в лучшем настроении — к сожалению, люди не читают руководства пользователя для развлечения:)

Конечно, гораздо проще использовать некоторые сервисы проверки орфографии. Довольно часто эта функция присутствует в инструментах для разработки документации из готового продукта. К примеру, проверьте WYSIWYG редактор в ClickHelp (инструмент для написания онлайн-документации), который позволяет сразу же обнаружить ошибки, опечатки и их исправить.

Итог

Это те стадии, которые Вы должны пройти, чтобы правильно протестировать документацию пользователя. Чтобы быстро все подытожить:
• Проведите проверку безопасности — убедитесь, что все критические условия верны; убедитесь, что все действия, которые могут вызвать серьезные проблемы, четко описаны;
• Проведите проверку согласованности — более пристально изучите структуру документации, навигацию;
• Проведите проверку пользовательского интерфейса — убедитесь, что все корпоративные стандарты пользовательского интерфейса соблюдены.

Конечно же, Вы должны всегда делать заметки и исправлять любые проблемы,, которые видите даже если это опечатки, а Вы в данный момент ищите нерабочие ссылки.

*Об авторе – команда ClickHelp*

Этот гостевой блог был на написан продавцом онлайн инструмента документирования ClickHelp. ClickHelp — это современный инструмент на основе браузера в облаке. Он может производить онлайн и печатную документацию, базы знаний, документы PDF, контекстную справку, внутренние нормативные документы. ClickHelp объединяет среду разработки документации для команд и портал документации для конечных пользователей. Чтобы узнать больше об инструменте документации ClickHelp, посетите этот веб-сайт: https://clickhelp.co

Оставить комментарий