Работая SAP-консультантом, естесственно, довольно часто приходится обращаться к SAP-документации. И всё бы ничего, ответ почти всегда находится. Но есть один неприятный момент в получении нужной информации на “хэлпе” (help.sap.com) - отсутствие скриншотов.

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

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

Сравните два варианта описания, представленных ниже.

Вариант 1.

(Оригинальный пример из “хэлпа” - Руководство пользователя SAP BusinessObjects Web Intelligence)

Запуск Web Intelligence на стартовой панели BI

Приложение Web Intelligence можно запустить несколькими способами.

Для запуска Web Intelligence выполните одно из следующих действий:

  • Выберите Приложения  Web Intelligence.
  • Среди ярлыков приложений выберите Web Intelligence.

Вариант 2.

(Тот же самый пример из “хэлпа” дополненный скриншотом)

Запуск Web Intelligence на стартовой панели BI

Приложение Web Intelligence можно запустить несколькими способами.

Для запуска Web Intelligence выполните одно из следующих действий:

  • Выберите Приложения  Web Intelligence.
  • Среди ярлыков приложений выберите Web Intelligence.

Пример использования скриншота в технической документации

Ясно, что пример достаточно простой. Но всё же какой вариант более понятный? Как по мне, так это второй.

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

В голову приходит фраза из рекламы 90-х (вот же засела где-то глубоко в мозге, будь она неладна), которую хочется переделать в соответствии с темой заметки - “Просто добавь… скриншот”.

Так вот основная мысль заметки очень простая.

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