При написании процедурной документации я могу написать полные пошаговые инструкции со ссылками на приложение с иллюстрациями,
Например:
1. Do task 1 (see Fig. 1)
2. Do task 2 (see Fig. 2)
Illustrations
-------------
+-------+
| Fig 1 |
+-------+
+-------+
| Fig 2 |
+-------+
или сопровождать каждый шаг иллюстрацией, как если бы шаги были подписями к иллюстрациям,
Например:
+-------+
| Fig 1 |
+-------+
1. Do Task 1.
+-------+
| Fig 2 |
+-------+
2. Do Task 2.
Есть ли какие-либо исследования, чтобы показать, какой метод более эффективен для человека, пытающегося выучить материал? Какие соображения мне необходимо учитывать при выборе одного метода вместо другого?
Если это имеет значение, каждый документ состоит из 10-15 страниц, из которых около 25% текста и 75% иллюстраций.
Во-первых, спросите себя, нужны ли все иллюстрации (т. е. эти снимки экрана иллюстрируют экран с одной кнопкой?).
Читатель будет очень раздражен необходимостью переключаться между процедурой и диаграммой. У меня нет никаких ссылок, чтобы показать вам это, но я провел реальное тестирование с пользователями, и ошеломляющий результат заключается в том, что иллюстрация соответствует процедуре, даже если одна и та же иллюстрация дублируется в 15 различных процедурах.
Однако, если вы говорите о программном обеспечении, лучше иметь информацию, встроенную в сам экран программного обеспечения (либо всплывающую подсказку, либо всплывающее руководство), чем заставлять пользователя искать информацию в документации (потому что они не будут ).
РЕДАКТИРОВАТЬ: Ведение такого рода документации становится бременем для автора, особенно если они не разместили иллюстрации по ссылке, и каждая из них должна обновляться индивидуально.
Моника Челлио