Когда скриншот действительно полезен в учебной документации?

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

Когда использовать скриншоты?

• Вам нужен контекст пользовательского интерфейса, чтобы указать, как выполнить конкретную задачу.
• Он подчеркивает необычный выбор интерфейса или добавляет ясности и позволяет сократить текст, то есть сохраняет несколько описательных предложений о параметрах, необходимых для выполнения процедуры.
• Для ссылки на безымянный элемент пользовательского интерфейса в задаче, и читатель не может легко идентифицировать или найти его без выноски.
• Чтобы выделить различия между двумя версиями продукта, например, между старой и новой или между Mac и Windows.

Когда не использовать скриншоты?

• Для отслеживания прогресса пользователя на различных экранах, встречающихся в рабочем процессе.
• Исключительно для того, чтобы помочь читателю найти легко идентифицируемые элементы пользовательского интерфейса. Вы можете использовать встроенный значок, если считаете, что для помощи читателю необходим графический элемент. Например, если в пользовательском интерфейсе есть нестандартная иконка, поместите иконку 16x16 в инструкции, предлагая пользователю щелкнуть по иконке. Кроме того, размещайте пользователя в пользовательском интерфейсе, используя текст, такой как верхний левый угол, правая боковая панель, левая боковая панель и т. д.
• В конце шага задачи, исключительно для демонстрации результата шага, если только скриншот не служит для того, чтобы убедить пользователя во время выполнения сложной процедуры.

Все упирается в знакомство аудитории с интерфейсом. Слова процедуры описывают части интерфейса. Узнают ли зрители сразу, к каким частям интерфейса относятся эти слова? Если да, то скриншоты излишни и просто замедлят чтение. Если нет, то вам нужен способ показать читателю, к какой части интерфейса относятся слова, и скриншот — один из способов сделать это.

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

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

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

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

Короче говоря, используйте их там, где вы предполагаете, что они могут понадобиться значительной части вашей аудитории, а в других случаях — нет.

Я уже писал на эту тему раньше .

Документация ПО часто повторно используется для разных версий одного и того же программного обеспечения. Поэтому важно свести к минимуму количество используемых снимков экрана. Почему?

• Использование устаревших снимков экрана вызывает много путаницы.
• Замена/обновление снимков экрана — это большая работа.
• Если это не сложно сделать, снимки экрана всегда должны сопровождаться подписью, поясняющей, что полезного и/или важного в снимке экрана. Вместо того, чтобы использовать общий диалог «Сохранить как», вы должны сказать «Ms Word позволяет сохранять в различных форматах», а затем показать раскрывающийся список всех форматов, в которых сохраняет MS Word.
• Снимки экрана занимают много места и, как правило, не должны использоваться для длинных тем. Если на одной странице более трех скриншотов, вероятно, что-то не так.
• Лучшее время для использования снимков экрана в документации — показать неочевидную функцию или показать, как выглядит ПО, когда оно обрабатывает данные в реальном времени.
• Лучшие контексты для использования скриншотов? Они особенно хороши для начинающих пользователей и иллюстрируют проблемные состояния в программном обеспечении.
• Скринкасты также становятся эффективным методом передачи общего смысла пользовательского интерфейса. Они особенно эффективны для быстрых экскурсий и иллюстрации общего хода работы за короткий период времени, но они все же не заменяют обычную документацию.

Я вам отвечу не как писатель (техдокументацию не пишу), а как пользователь .

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

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

Многое может пойти не так с документацией, но поскольку ваш вопрос касается скриншотов, я сосредоточусь на них.

Почему все люди любят кино и телевидение, но не книги? Почему мы пишем на анкеты знакомств с изображениями, а не без? Почему мы используем PowerPoint, а не просто разговариваем со своей аудиторией? Потому что люди предпочитают визуальную информацию текстовой. Мы можем обрабатывать его быстрее и в больших объемах.

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

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

Почему люди любят кулинарные книги с пошаговыми изображениями? Потому что их кухня не текст. Их кухня — это визуальный опыт, и если кулинарная книга показывает, как должна выглядеть кухня (или ее часть: кастрюля), это значительно упрощает понимание процедуры и проверку того, соответствует ли то, что делает повар-любитель, плану. легко, быстро и весело. То же самое касается программного обеспечения: когда у меня возникает проблема, я открываю программное обеспечение и делаю то, что мне говорит документация. Мне просто нравится , когда я могу прокручивать аннотированный вручную скриншот за аннотированным снимком экрана, пока я делаю то, что показано в параллельном окне программного обеспечения. Почему дети следуют дурному примеру своих курящих (или некурящих родителей), а не тому, что им говорят? Потому что они делают то, что видят ! Так:Скриншоты помогают пользователям понять и научиться использовать свое программное обеспечение.

Слова абстрактны, а абстракция не естественна для большинства (если не для всех) людей.

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

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

Скриншот дополняет то, что вы говорите, или просто для красоты? Я считаю, что маркетинговые материалы должны быть «красивыми», а техническая работа должна быть сосредоточена на обучении и понимании.

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

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

Полагаю, многое зависит от того, насколько хороши слова. Хорошо писать сложно, а вот сделать снимок экрана может и обезьяна.