Comments 5
PDF, HTM, CHM…
.HLP не хотели?
Можно и без «жирный»|«курсив» (в командной строке винды он хоть и возможен, но только для всего текста сразу, и то из-за глючного переключения MultiByte↔SingleByte кодировок…). Четверть века прошло, попробуй найди сейчас КОНСОЛЬНЫЙ просмотрщик виндовых .HLP (не DOS`ных)! На этой картинке, FreePascal вместо изображений — заглушка [img] текстом, и почему-то с недогруженным остальным поясняющим текстом!
Пытаюсь поиском на хабре найти ту тему с демонстрацией отображения полноцветных (24-разрядных?) картинок в консольных приложениях винды — тут бы уж точно пригодилось!
PDF ненавижу из-за бесящих колонтитулов и полей (уж точно никому не нужных), неадекватных просмотрщиков (масштабируют неадекватно, да ещё и клавиатуру как положено не адаптировали, например Foxit Reader мог вовсе перестать реагировать на стрелки, в т.ч. с Shift)…
HTML — да, бывали косяки с навигацией и у IE после случайных "неправильных сочетаний клавиш" (хоть лечилось только «тыканием мышкой»)…
WinHlp32 и hh — вообще для работы с клавиатурой не предусмотрены!
Остаётся только .RTF (либо декомпилированные в него .HLP`хи) и .DOC(X)… Хотя иногда хватает и банальных .txt :)
И всё ж, (M)HTML для меня предпочтительнее единого CHM, несмотря на "суперсжатие" последнего.
Спасибо за полезные советы. Как раз для меня "к месту" - готовлюсь пройти курс "Технический писатель".
Так 8 или 10 "вредных" советов?)
И последний очень даже "полезный" совет ;)
Добавлю парочку из практики:
1. Не ведите контроль версий документации и не указывайте в файле с описанием - текущей версии и даты. Пусть пользователь сам разбирается, какой из 3-5 документов актуальный. Если ему лень это делать, значит и документация не поможет.
2. Называйте файл со справкой "Документ Microsoft Word.docx", "File.docx", в крайнем случае - "Справка.docx". Пользователь должен помучаться при поиске файла в сохранённых или в истории просмотра. Так он будет более трепетно относиться к результатам нашего труда.
10 вредных советов для документации