Dimdim SoftWare
Мастерская Dr.dimdim
ГлавнаяПоискНаписать письмо
ГлавнаяМоделированиеПроектированиеТЗРазработкаИнтерфейсСтатьиСсылкиАвтор
СПИСОК СТАТЕЙ

Справочные системы

 

Рекомендую

Как писать документацию - статья о правилах написания справочной системы

 

Главная > Справочные системы

Раздел "Справочные системы"

Раздел "Справочные системы" представляет информацию по проектированию и разработке справочных систем к программным продуктам.


Технология HTML Help
23.09.2005
Технология HTML Help создана как современный аналог предшествующей ей технологии Microsoft под названием WinHelp, представляющей из себя ни что иное, как многостраничный документ, поддерживающий форматирование и обладающий развитой системой текстовых ссылок. Самое широкое распространение технология WinHelp и созданные с ее помощью справочные файлы (имеющие столь известное расширение .HLP) получили в качестве справочной информации, сопутствующей различным програмным продуктам для облегчения их использования. Технология HTML Help, пришедшая ей на смену, и откомпилированные файлы справки (имеющие расширение .CHM), выгодно отличается от своей предшественницы .

Зайцев О.В.,Смоленск,1996
23.09.2005
Создание мультимедиа книг, справочников и энциклопедий в формате HLP файла под Windows 3.1 и Windows 95 на базе текстового файла Microsoft Word 6.0-7.0. Создание систем контекстной помощи для программ, написанных на Delphi 32, C for Windows ...

Зачем нужна документация
21.10.2003
Многие разработчики считают, что справочная система для их продуктов совершенно не нужна. Это и не удивительно: автор досконально знает свое творение, и оно кажется ему абсолютно простым для понимания и освое­ния. Если быть откровенным, то у программистов существует прямо-таки природное отвращение к написанию документации: это занятие представля­ется им на редкость

Виды документации
21.10.2003
Текстовый файл
Чисто теоретически, документация может быть выполнена в виде обычного текстового файла — например, readme.txt. Однако для серьезной программы один текстовый файл — явно недостаточно. В крайнем случае, readme.txt может быть временной заменой справочной системы на этапе, когда программа существует в виде бета-версии. У готового же к продажам продукта документация должна быть оформлена в одном из форматов, специально предназначенных для справочной системы.

Как писать документацию
21.10.2003
Прежде чем писать документацию, нужно определить ее будущую структуру, т. е из каких разделов она будет состоять.

На выбор структуры справочной системы программы влияют два фактора. Во-первых, разработчик пишет не просто описание программы, а систему помощи, которую пользователи будут читать чаще всего при воз­никновении каких-либо проблем при работе программой, а не от праздного любопытства. Во-вторых, автор программы разрабатывает ее не "для себя", я для продажи на рынке.


Средства создания документации
21.10.2003
Сделать справочную систему не так уж сложно. Для создания справочных файлов в формате WinHelp можно использовать Microsoft Word, а также бесплатный компилятор Help Workshop, который можно скачать с сайта Microsoft или взять из дистрибутивов многих средств разработки приложе­ний (Visual C++, Visual Basic, Delphi) или специализированных продуктов для создания справочных файлов. Для подготовки Справки в формате HTML Help требуется любая программа для редактирования HTML (от про­стейшего Блокнота до навороченного Frontpage 2000) и, опять же, компи­лятор.
Главная| ИС.. | Моделирование | Проектирование |ТД | Разработка | Интерфейс | Статьи | Ссылки | Автор
DimDim SoftWare Мастерская Dr. dimdim Copyright 2003-2004
Администратор info-system@mail.ru
Последнее обновление 26-Дек-2003