Helpsoft

·       Практически никто не читает документацию, в каком либо виде от начала до конца. Пользователь хочет найти ответ на свой вопрос и как можно быстрее. (Я ни разу не видел, чтобы моя жена прочитала хоть какую-нибудь часть инструкции по использованию того или иного прибора. В результате, она стирала не правильно белье в течение трех лет, приговаривая, что-то оно серое!)

·       Совет по написанию справки, еще.

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

·       Не используйте ничего кроме стандартных шрифтов предлагаемых Word – все затем можно переопределить через внешний файл стилей.

·       Использовать символ # в именах и путях файлов не рекомендуется, поскольку он зарезервирован для определения закладок в URL.

·       Не создавайте большое количество стилей, от них рябит в глазах.

·       Пишите короткие секции, чтобы она уместилась в 1-2 экрана Справки, а не в 10, иначе придется скролировать текст, а это сбивает с мысли и утомляет.

·       Один параграф для одной мысли. Это легче читать и понимать.

·       Используйте короткие предложения. Это позволяет более ясно и однозначно выразить мысль. Сложные предложения, говорят скорее о том, что вы сами не ясно представляете, о чем пишите.

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

·       Избегайте неоднозначности. Избегайте фраз типа "Возможно, это будет...". Не используйте двойных отрицаний.

·       При написании документации используйте максимально простой стиль. Добиться наилучшего представления Справки лучше всего через внешний файл стилей. Печатный вариант документации также лучше получить с помощью фирменного стиля через Темы или подбор стиля в MS Word (Формат/Тема…).

·       Дайте своим глазам отдохнуть каждые 15 минут, посмотрите вдаль 15 секунд,  15 секунд попеременно смотрите вправо-влезо-верх-вниз и/или сделайте круговые движения глазами. Примите правильную позу.

·       Через 45-50 минут встаньте, пройдитесь, разомнитесь.