Рисунок D.1 — Иерархия аудиторий
В ряде случаев иерархию аудиторий целесообразно представлять в виде отдельных групп, как показано на рисунке D.1.
В ряде случаев следует выбирать аудиторию, исходя из опытности пользователя данной аудитории по использованию системы. Например, аудитории могут быть определены как «Неопытные пользователи» или «Опытные пользователи».
После определения перечня аудиторий для конкретной системы на следующем этапе следует определить задания (tasks), выполняемые каждой аудиторией. Часто данные задания представляют в виде иерархической структуры (см. рисунок D.2).
Рисунок D.2 — Иерархия заданий
На следующем этапе для определенной аудитории в рамках выданных ей заданий определяют перечень ее потребностей в информации (information needs). На основе данного перечня определяют содержание конкретного документа, как показано на рисунке 3.
Рисунок D.3 — Информационные потребности
На данном этапе (но не ранее) следует определить вид (тип) конкретного документа и машинный носитель, на котором он поставляется.
Например, информационные потребности данной аудитории в рамках конкретного задания могут быть удовлетворены в формате печатного руководства, диалогового руководства, контекстно-зависимых справочных экранов, справочных схем или видео- и оперативных руководств.
Обычно стремятся сократить номенклатуру разрабатываемых документов. При этом стараются один документ использовать в разных целях.
На рисунке D.4 показаны виды деятельности (работы), выполняемые в процессе проектирования документации. Одним из важных моментов является представление пользователю необходимых сведений на различных носителях; потребность в этом не предопределяется ролью диалоговой или бумажной документации; ролью любого носителя является представление пользователю необходимых сведений в требуемом виде (формате) в зависимости от конкретной аудитории, продукта и набора заданий пользователя. Планирование документации (в соответствии с настоящим стандартом) связано только с установлением набора сведений, необходимых пользователям, и лишь в конце процесса документирования решается вопрос о выборе носителя, на котором следует представлять эти сведения. Например, диалоговую и бумажную документацию следует планировать одновременно, так как одному пользователю для получения необходимых сведений может потребоваться документация обоих видов.
Рисунок D.4 — Общая структура процесса проектирования документирования
Более подробное описание процесса проектирования документации приведено в BS 7649-93 [2].
ПРИЛОЖЕНИЕ Е (справочное)
Рекомендации по написанию на английском языке документации, подлежащей последующему переводу
Е.1 Общие положения
В настоящем приложении приведены рекомендации, которые следует учитывать при написании на английском языке исходных материалов, подлежащих последующему переводу на другие языки. Большая часть данных рекомендаций относится как к бумажной, так и диалоговой документации.
Е.2 Терминология
В части терминологии, используемой в документах, необходимо руководствоваться следующими правилами:
a) применять общие и нетехнические термины в соответствии с их определениями, установленными в общих словарях;
b) создавать глоссарии (словники), содержащие:
1) определения всех специфических и неизвестных терминов,
2) виды и определения всех обозначений и сокращений,
3) толкования непривычного использования слов, применение имен существительных в качестве наречий,
4) библиографию специализированных словарей и стандартов;
c) специальная терминология должна быть основана на национальных или международных терминологических стандартах, общепризнанных словарях или согласованных глоссариях;
d) каждое сокращение должно быть расшифровано при первом его появлении в тексте основной части документа;
e) каждый термин должен одинаково трактоваться в документе, диалоговой информации и системной библиотеке;
f) составные выражения (например, «ввод данных [data input]») должны иметь одно смысловое значение во всей документации;
g) составные выражения не должны содержать более трех слов;
h) одно и то же слово не должно использоваться для различных частей речи;
i) все специфические и специальные термины должны использоваться в соответствующем контексте;
j) термины, вводимые вне соответствующего контекста, например наименования клавиш или команды, должны быть определены в глоссарии;
k) следует избегать использования термина «биллион (billion)».
Примечание — Американский биллион (109) не совпадает с английским биллионом (1012);
1) следует избегать использования термина «перевод (translation)», например при ссылке на перевод в формат файла, в смысловом значении, отличном от перевода с одного языка на другой. Вместо этого следует применять термин «преобразование (conversion)».
Е.3 Стиль перевода
Е.3.1 Обозначения
Следует использовать только общепринятые обозначения, которые должны быть расшифрованы в списке обозначений. Не должны применяться следующие обозначения:
a) американский символ «#» для фунта;
b) приподнятая точка () для операции умножения.
Е.3.2 Неоднозначно трактуемые слова
Авторы документов должны избегать использования следующих неоднозначно трактуемых слов:
а) who (кто), that (который), which (какой);
b) only (только), merely (приблизительно), just (едва), mainly (в основном), simply (просто);
с) while (пока);
d) so (таким образом);
e) as (как);
f) can (иметь возможность), may (мочь);
g) since (так как);
h) when (когда), if (если);
i) alternate (дополнительный), alternative (альтернативный).
Е.3.3 Синтаксис
Должны быть учтены следующие вопросы синтаксиса:
a) предложения не должны быть слишком длинными;
b) следует избегать построения предложений, описывающих ряд положений, разделяемых чрезмерным количеством запятых;
c) пункты, содержащие определенные ограничения, и пункты без ограничений должны быть представлены раздельно.
Е.3.4 Пунктуация
Там, где могут быть использованы скобки или точка с запятой, не следует применять тире.
Е.4 Физические факторы
Необходимо учитывать следующие физические факторы:
a) сокращения нецелесообразно использовать только для экономии места;
b) предусмотреть необходимые места для простановки соответствующих значений, например цены;
c) следует использовать стандартные графические инструментальные средства (пакеты) и избегать применения вклеек;
d) избегать внесения поясняющего текста в рисунки;
e) следует использовать графические символы, имеющие общепринятое смысловое значение;
f) по возможности вместо словесного пояснения использовать графические изображения.
Е.5 Диалоговая информация
Применительно к диалоговой информации необходимо учитывать следующие положения:
a) при наличии обратной связи с разработчиками программных средств следует обеспечить выделение диалоговой информации (текстов и сообщений) из логики программы;