Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Когда вашей документации требуются скриншоты?

30.09.2015

01Скриншотам – быть или не быть? Существуют ситуации, когда скриншоты необходимы, но в основном они только мешают. Какой потенциальный вред от скриншотов бывает и как определиться с их количеством – читайте в статье.


Один из частых вопросов при разработке документации: «Сколько скриншотов она должна включать?» Ответы разнятся от «Ни одного!» до «Все окна!». Картинка может заменить тысячи слов, но скриншоты часто используются в качестве «костыля» для некачественной документации или некачественного дизайна. Лучший ответ — использовать их там, где необходимо, и не использовать в других случаях. Но как узнать, когда они необходимы?

Иллюстрации плохо объясняют идеи

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

Какой уровень у вашей аудитории?

Конечно, аудитория — важный фактор. Если пользователь имел опыт работы с графическим интерфейсом ранее, вам нет необходимости описывать меню «Файл -> Печать». Если же вы пишете для полных новичков, то, возможно, это хорошая идея. Точно так же, если читатель является опытным пользователям, вам нет необходимости создавать скриншоты для каждого всплывающего окна. «Ошибка: файл не найден» и «Ошибка: невозможно записать файл» не являются достаточно необычными для того, чтобы требовать графического пояснения, особенно если в обоих случаях единственным действием является нажатие кнопки «ОК».

 

02

Пример правильного использования скриншота от Slack; подсветка особых областей пользовательского интерфейса, с которым пользователи могут быть не знакомы.

Меньше – значит больше

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

Второй ответ заключается в том, что если интерфейс, который вы описываете, может отображаться с использованием разных тем или может быть сконфигурирован, человек, который делает скриншоты, может использовать тот вариант, который не соответствует варианту по умолчанию, что, опять же, смущает читателя. (Обратите внимание, что «мы будем использовать конфигурацию по умолчанию, чтобы делать скриншоты» — не всегда хороший ответ, т.к. изменения могут затронуть настройки по умолчанию).

Третий ответ — скриншоты невозможно перевести. Если ваша документация переводится на множество языков (и в самом деле, разве вы не надеетесь, что ваш проект станет достаточно популярным для того, чтобы множество языков стало одним из требований?), вашим переводчикам нужно будет воспроизводить скриншоты на целевом языке. Или же ваши переведённые документы станут второсортными.

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

Скриншоты — не костыли

«Но скриншоты добавляют некоторый приятный визуальный стиль и помогают разделить стену текста!» Ваш аргумент меня не убеждает. Хорошо размеченный контент тоже разделяет стену текста. Если только вы не публикуете сплошной текст, выбранный вами язык разметки наверняка может использовать кое-какие стили, CSS, и это помогает достичь визуальной привлекательности. Серия книг «Для чайников» — один из моих любимых примеров документации и в большинстве из этих книг используется минимум скриншотов. Частые выноски и заголовки разделов разделяют текст.

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

Источник: When does your documentation need screenshots?

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов