На чем пишем документацию

Флейм. Только просьба - не материться! :)

Модератор: Дед Пахом

Аватара пользователя
finsoftrz
✯ Ветеран ✯
Сообщения: 5992
Зарегистрирован: 06 Ноябрь 2014, 12:48
Благодарил (а): 25 раз
Поблагодарили: 88 раз

На чем пишем документацию

Сообщение finsoftrz »

Я думаю, одно должно дополнять другое. Главное не нудить в обоих случаях.
C6/C12, ШВС, tps/btrieve.
Аватара пользователя
finsoftrz
✯ Ветеран ✯
Сообщения: 5992
Зарегистрирован: 06 Ноябрь 2014, 12:48
Благодарил (а): 25 раз
Поблагодарили: 88 раз

На чем пишем документацию

Сообщение finsoftrz »

В chm есть возможность вставки ссылок на другие chm. Обычная справка, которая интегрирована с программой (F1, кнопка на тулбаре) содержит только текстовые описания, иначе будет сильно раздуваться. А в ней можно сделать ссылки на другие chm, которые уже содержат инструкции со скриншотами или видео. Например, можно в разделах основного chm файла делать разворачиваемые области, а в них ссылки. Ссылка открывается прямо в контексте окна основной справки. Крутенько получается. По поводу роликов avi есть, конечно, неоднозначность, они много места занимают. Но есть возможность располагать их в отдельном каталоге, путь до которого задавать в настройке программы. Эта схема может работать и на защищенных терминальных серверах, если в chm при сборке отключена возможность настроек параметров, к файловой системе доступ исключается.

То есть, такой универсальный подход, все делается в Help&Manual, интегрировано с приложением, пользователь в каком-то окне жмет Помощь, ему дается описание и возможность перейти по ссылкам на инструкции или видео ролики.

tb1.png

tb2.png
C6/C12, ШВС, tps/btrieve.
Ответить