Изображения аннотировали, аннотировали, да так и не зааннотировали.
Скороговорка технического писателя
Аннотация изображений стала очень популярной темой в связи с развитием интеллектуальных систем распознавания изображений и необходимости их обучения. Но в данной статье речь пойдет о более прозаичных задачах – аннотирование изображений в документах и справочных руководствах.
Для аннотирования отдельных изображений я использую скриншотер от Mail.ru, который может накладывать на выбранный фрагмент экрана стрелки, рамки, цифры в кружочках и прочие вспомогательные элементы, необходимые для аннотации изображения. Эта программа хорошо подходит для разового применения, например, если нужно добавить поясняющее изображение в письмо или иллюстрацию для статьи в блоге, то есть в случаях, которые не предполагают редактирование таких изображений.
А вот при ведении технической документации часто требуется корректировка аннотированных изображений. До знакомства с программой Dr.Explain это было проблемой, так как приходилось каждый раз создавать новое изображение. А если это изображение формы, то нужно было создавать белый фон, размещая на заднем плане развёрнутый на весь экран “Блокнот”. Но теперь у меня есть удобный инструмент для аннотации изображений, который умеет автоматически распознавать экранную область, а также элементы интерфейса приложений (включая JAVA приложения) и HTML-форм.
Теперь я могу сделать изображение всего экрана или его области, изображение формы приложения или его отдельного элемента, сохранить его в документе и приступить к его аннотированию. Большую часть этой работы Dr.Explain делает за меня самостоятельно: размещает выноски и создаёт разделы с описанием для каждого элемента. Остаётся добавить пояснения и скрыть те элементы, которые в данный момент не нужны.
Также можно вручную добавлять фрагменты для аннотации, менять порядок следования элементов и расположение выносок. Можно корректировать область видимости исходного изображения. В конце концов можно заменить само изображения, сохранив элементы аннотации – это бывает необходимо, если на скриншоте запечатлели ошибку в программе, которую надо исправить, или туда попали конфиденциальные сведения, или вышла новая версия программы и требуется добавить описание всего одной новой кнопки.
Главной особенностью системы аннотирования изображений в документации является связывание элемента аннотирования (фрагмента изображения) с якорем (точкой перехода по гиперссылкам в документации). По этой причине аннотирование имеет четкую структуру элементов:
- Графическое изображение с метками
- Список меток с поясняющим текстом
Для создания аннотаций используются шаблоны: настройки для графических элементов, которые накладываются на изображение. У Dr.Explain есть несколько готовых шаблонов, но вы можете на их основе создавать свои собственные, которые будут соответствовать вашим представлениям или уже сложившимся корпоративным стандартам документирования. Инструмент шаблонов очень гибкий. Он позволяет легко заменить шаблон в уже готовом документе или использовать несколько шаблонов одновременно.
Так что всем, кто занимается ведением технической документации, я рекомендую dr.Explain – в части аннотирования изображений он великолепен.