элементов системы, либо по данному вопросу имеется отдельный рабочий топик,
на него желательно сделать гиперссылку.
1.4. Содержание справки обычно формируется средствами генератора Help’ов. В
структуре содержания желательно выделить теоретическую часть (основные
понятия и используемые методы), глоссарий и рабочие топики.
1.5. При создании справки должен, по возможности, выдерживаться единый стиль.
Цвета и размеры фона и шрифтов, оформление заголовков и гиперссылок, должны
быть приятными и удобными для чтения. При выборе стиля желательно
придерживаться фактического стандарта Windows. Различия в оформлении должны
помогать ориентироваться в справочном файле. Например, рабочие, и методические
топики могут отличаться каким-либо элементом стиля (цветом фона, формой
заголовка или видом шрифта).
1.6. До каждого топика мы должны как-то добраться: он может быть вызван
непосредственно из программы, указан в оглавлении или на него должна быть
гиперссылка из других вызываемых топиков.
2. Требования к рабочим топикам. Эти топики должны вызываться контекстно из
каждого экрана программы. Основные требования к ним:
2.1. Унификация терминологии. Все термины, обозначения в разных топиках
должны быть одинаковы. Они также должны соответствовать тому, что
присутствует на экране рабочей системы – названию экранов, названию элементов
экрана, органов, элементов управления, и т.д. (Напомню, что сами названия
экранов и элементов, расположенных на экране должны быть унифицированы, и
носить содержательный характер, выражать именно тот смысл, который они несут).
2.2. Полнота описания. В топике должны быть описаны все элементы,
присутствующие на экране и все состояния, в котором может находиться тот или
иной элемент. Для каждого элемента надо сказать, что он означает, какую роль
выполняет, что значит то или другое его состояние. В тех случаях, когда
используются какие либо унифицированные элементы, (например, кнопки, которые
могут присутствовать на разных экранах и имеющих одинаковое значение), для
описания такого унифицированного элемента создается отдельный топик, и если
такой элемент присутствует на экране, в топике для этого экрана дается
гиперссылка на описание такого унифицированного элемента.
2.3. Описание порядка работы. В рабочем топике должны присутствовать ответы на
следующие вопросы:
2.3.1. Для каких целей предназначен этот экран, какие задачи решаются с его
помощью. Они могут быть обозначены очень кратко, более подробное
описание будет содержаться в методическом топике, вызываемом по
гиперссылке.
2.3.2. Какие действия и в какой последовательности необходимо или возможно
производить с помощью этого рабочего экрана. Каким образом
активизируются элементы управления – мышью, клавишами, и т.д. Те или
иные условия таких действий могут быть только обозначены, более
подробное описание будет содержаться в методическом топике, вызываемом
по гиперссылке.
2.3.3. Если необходимо вводить какие-то данные на экране, следует указать,
откуда следует взять эти данные, и способ их введения. При необходимости
указывается формат данных, или другие их характеристики.
2.3.4. Что в результате происходит при работе с этим экраном. На какие экраны
происходит переход с этого экрана, в каких случаях. Для интерпретации
получаемых результатов делаются гиперссылки на соответствующие
методические топики.