ГОСТ Р ИСО/МЭК 15910-2002
ПРИЛОЖЕНИЕ G
(справочное)
Оценка плана документирования
Использование настоящего стандарта во взаимоотношениях между заказчиком и документатором спо
собствует созданию качественной документации в частности потому, что между ними согласовывается план
документирования. Этим достигается двойной эффект: во-первых, документатор учитывает все аспекты доку
ментации. оговоренные в плане: во-вторых, заказчик и документатор согласуют метод документировании,
определенный в плане, сше до начала работы.
Заказчик должен установить наличие в плане документирования следующих элементов:
a) соответствующих определений всех аудиторий. Формулировка вида «Руководство предназначено для
аудитории, охватывающей пользователей программного средства* неполна (см. приложение D). Вопределение
аудитории должны быть включены все лица, могущие использовать данное программное средство (включая
лин, которые могут только просматривать отчеты или сообщения от данного средства):
b
) содержания (планов-проспектов) документации с оценкой их постраничного объема;
c) определения числа печатных копии и методов печати (тиражировании) и брошюровки документации;
d) однозначного определения собственника авторских прав на документацию;
с) установление методов подготовки документации. Большинство технических документов может быть
создано при помощи компьютера;
0достаточных сроковдля проверки заказчиком редакций документации. Любые отсрочки при возврате
документатору проверенных редакций могут привести к срыву сроков поставки документации;
g) от организации-заказчика можег потребоваться обеспечение документатора соответствующими ресур
сами (доступом к се персоналу, оборудованием и т. д.), при отсутствии которых работы могут быть сорваны.
В целом план документирования должен учитывать все специфические обстоятельства, относящиеся к
организации-заказчику и пользователям. Крайне маловероятна возможность использования плана документи
рования. разработанною в рамках одного проекта, для другого.
ПРИЛОЖЕНИЕ Н
(справочное)
Образец спецификации стиля
11.1 Общие положения
Представленный образец спецификации стиля документации соответствует требованиям 8.2 и по умол
чанию может быть использован в плане документирования.
П р и м е ч а н и е — Перед окончательным принятием данной спецификации полезно создать на се
основе модель документа.
11.2 Элементы стиля
Втаблице НЛ приведены элементы стиля и их рекомендуемые значения по умолчанию.
Т а б л и ц а
Н.1 —Элементы стиля и их значения
Э л е м е н тЗ н а ч е н и е
Язык
Английский
Орфографический словарь
Сюварь Маквайра
Руководство по грамматике и использова
нию стиля
•Руководство поcmu.noдля авторов, редакторов и издателей»
Австралийское государственное издательство
30