Милостивый государь, технический писатель

Исходный текст очень старый, но своей актуальности не потерял ни разу :)

Собственно статья была опубликована в Компьютерре аж в 2001 году, но сколько она мне сил сэкономила! Ссылка.

Собственно pdf-ка, если вдруг ссылка станет недоступной. Печатал напрямую с сайта, так что там и реклама затесалась. Но для понимания, думаю, это некритично.

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


Вот только не удержусь - добавлю пару замечаний. Опять же, это "для себя", на истину не претендую ни разу:

1. Если разрабатывается экранное руководство, то лучше использовать шрифты без засечек (Arial, Calibri и т.п.). Для бумажных копий часто лучше воспринимается нечто наподобие Times New Roman. Размер, межстрочное расстояние, расстояние между абзацами и т.п. - сами выбирайте :)
2. Последовательность действий зачастую невозможно описать словами. И видео предоставить нереально. Выход один - дать последовательность скриншотов.
   Такую методику (спасибо, Илья!) мне подсказали во время разработки первого тест-драйва по AutoCAD: объединить скрины и описание в таблицу. Одна строка - одно логически завершенное действие. Если в такой логической единице надо выполнять несколько действий, то:
   а) количество таких действий не должно быть больше 3-4.
   б) если действий больше 1, то все должно быть пронумеровано. Выбираемые опции, нажимаемые кнопки и т.п. должны быть выделены.
   
   
   
   
   Все скриншоты должны быть выполнены в едином стиле. Если начинается черезполосица - здесь так, здесь этак, а вот здесь мне захотелось вместо синего цвета для акцентирования внимания использовать зеленый - то ценность такой документации моментально стремится к нулю.
   
3. Кстати, касательно скриншотов. Я выработал для себя правило: скриншот, если он делается в Windows, выполняется для классической схемы оформления, с установками шрифтов "по умолчанию". Никаких дополнительных эффектов типа затенения меню и т.п. красивостей. Все это можно сделать в растровом редакторе.
4. Скриншоты  выполняются для окна приложения размером 1024х768 точек. Вручную установить размер окна с такой точностью, конечно, нереально, но методы есть. Например, бесплатная программа Sizer. Скажу честно - мне она понравилась. По крайней мере пока :)
5. Скриншоты масштабируются только в момент вставки в результирующий документ. И вставлять скриншоты в документацию лучше всего в едином масштабе. Например, для подавляющего большинства случаев достаточно выбирать из ряда 35%, 50%, 65%.
6. Текстовые пояснения внутри скриншотов лично я стараюсь ограничивать цифрами. Но шрифт-то все равно приходится устанавливать :) Поэтому: шрифт Calibri, размер - в зависимости от задачи. Пока что достаточно 72 размера.

Дополнительные файлы указателей мыши и рамки для номера, которые лично я использую, можно скачать отсюда:
Указатель мыши, формат png
Указатель мыши, формат GIMP (xcf)
Рамка для номера, формат png
Рамка для номера, формат GIMP (xcf)