Документация

ГЛАВА 7
ГЛАВА 7. Документация...
Зачем нужна документация
Зачем нужна документация Многие разработчики считают, что справочная система для их продуктов совершенно не нужна. Это и не удивительно: автор досконально знает свое творение, и оно кажется ему аб...
Один из самых крупных интернетархивов
Рисунок 7.1. Один из самых крупных интернет-архивов ПО — Tucows — не принимает программы без документации...
Виды документации
Виды документации...
Текстовый файл
Текстовый файл Чисто теоретически, документация может быть выполнена в виде обычного текстового файла — например, readme.txt. Однако для серьезной shareware-программы один текстовый файл — явно не...
WinHelp
WinHelp WinHelp (Рисунок 7.2) — настоящий долгожитель среди форматов справочных систем. Программа winhelp.exe, обеспечивавшая работу HLP-файлов, входила в состав еще шестнадцатиразрядных версий Wi...
Пример справочной системы в формате WinHelp
Рисунок 7.2. Пример справочной системы в формате WinHelp У WinHelp очень мало недостатков. Один из самых серьезных — невозможность печати всего справочного файла целиком, в результате чего приходи...
HTML Help
HTML Help HTML Help (Рисунок 7.3) — новый формат файлов для документации, разработанный Microsoft как замена "старичку" WinHelp. Первой операционной системой, в которую был включен HTML...
Пример справочной системы в формате HTML Help
Рисунок 7.3. Пример справочной системы в формате HTML Help HTML Help отражает новую политику Microsoft: во-первых, полная интеграция приложений с Интернетом, во-вторых, использование HTML как осно...
NetHelp — аналог HTML Help от компании Netscape
Рисунок 7.4. NetHelp — аналог HTML Help от компании Netscape Существует также несколько аналогичных форматов HTML Help, также использующих язык HTML для описания структуры справочной системы: NetH...
Adobe Acrobat
Adobe Acrobat Adobe Acrobat (Рисунок 7.5) был разработан компанией Adobe как более эффективная альтернатива HTML. Как известно, основное достоинство HTML -независимость платформы: HTML-документ мо...
Пример документации в формате Adobe Acrobat
Рисунок 7.5. Пример документации в формате Adobe Acrobat Adobe Acrobat, пo замыслу разработчиков, и предназначен для решения этой проблемы: документы в этом формате можно просмотреть не только в л...
Печатная документация
Печатная документация Документация, отпечатанная типографским способом, столь привычная для коммерческих программных продуктов, для shareware — явление очень редкое. Если она все-таки имеется, то...
Документация на Webсайте
Документация на Web-сайте Некоторые разработчики слишком буквально понимают термин "online help", который на самом деле обозначает справочную систему в электронном, а не печатном, виде....
WinHelp или HTML Help?
WinHelp или HTML Help? Как видно из предыдущего раздела, сегодня существует два реальных варианта для реализации справочной системы: WinHelp и HTML Help. Какой же из них предпочесть?...
Возможности
Возможности Конечно, по функциональности справочной системы HTML Help значительно опережает своего предшественника. К услугам разработчика все то, что поддерживает браузер Microsoft Internet Explo...
Скорость работы
Скорость работы Как уже упоминалось, для чтения СНМ-файлов формата HTML Help используется браузер Internet Explorer, который вызывает много нареканий за высокие требования к системным ресурсам и о...
Перспектива
Перспектива Здесь, конечно же, все козыри у HTML Help, который создан как замена WinHelp и усиленно продвигается Microsoft. Нет сомнений, что в будущем имеющие недостатки HTML Help будут устранены...
Как писать документацию
Как писать документацию Прежде чем писать документацию, нужно определить ее будущую структуру, т. е. из каких разделов она будет состоять. На выбор структуры справочной системы shareware-программы...
Контекстная справка
Контекстная справка Пользователи обычно не любят запускать справочную систему из меню Help (Справка), т. к. в этом случае приходится самостоятельно искать нужный раздел Справки. Зато они вполне го...
Помощник из Microsoft Office
Рисунок 7.6. Помощник из Microsoft Office Лучше сосредоточить свои усилия в другом направлении. Например, все диалоговые окна программы должны содержать кнопку Help (Справка). Это касается не толь...
Средства создания документации
Средства создания документации Сделать справочную систему не так уж сложно. Для создания справочных файлов в формате WiuHelp можно использовать Microsoft Word, а также бесплатный компилятор Help W...