ГОСТ Р ИСО/МЭК 15910-2002
В комплект документации нс следует включать диалоговую документацию и справочные тексты. Вся
информация об изучении аудитории и другие исходные материалы должны предстаатяться заказчиком.
Должно быть проведено одно тестирование на практичность при поставке первого модуля программно
го средства, которое должно предусматривать проверки всех функциональных возможностей данного модуля
винтересах пяти различных типовых пользователей.
В.З Практическое применение настоящего стандарта
Нсобхолпма адаптация настоящего стандарта в интересах потребителей и пользователей в целях его
практического применения.
Практическое применение настоящего стандарта обычно заключается в исключении и добавлении ряда
разделов, что должно быть оговорено соответствующим соглашением (как правило, в договоре, но возможно
и в плане документирования).
Практическое применение настоящего стандарта следует проводить тщательно, с учетом его общей
структуры.
ПРИЛОЖЕНИЕ С
(справочное)
Образец плана документирования. Документация пользователя для системы АВС —
административного управления магнитными лентами
С.1 Введение
В настоящем плане описана стратегия разработки документации пользователя для системы АВС. пред
ставляемой в виде комплекта документации XYZ. Определена область применения проекта, номенклатура
поставки документации и ресурсы, необходимые для се создания.
Данная стратегия предусматривает создание твердых копий документации идиалоговой документации в
виде справочных текстов.
Вслучае изменения данной стратегии следует пересмотреть план документирования.
С.2 Область применения н ограничения
В комплекте документации не предусмотрены инструкции по применению операционной системы, на
которой прогоняется система АВС. Однако для читателя должны быть указаны ссылки на соответствующие
руководства по данному вопросу.
Инсталляция, ввод вдействие и управление документацией системы АВС уже реализованы и нс рассмат
риваются в настоящем проекте.
С.З Оформление и стиль описания
По умолчаниюследуетиспользоватьоформлениеистильописания,указанныев
ГОСТ Р ИСО/МЭК 15910. Образец страницы приложен к плану документирования.
Т а б л и ц а С. I —Руководство по стилю
Э л е м е н тЗ н а ч е н и е
Содержание справочного текста
Должен быть описан только контекст справки
Содержание диалоговой документации
Отсутствует
Сопутствующие материалы
Справочный текст дли каждого объекта должен быть
представлен на одном экране
Засветки и использование цветов
Всправочном тексте не следует использовать цвета и
другие засветки
Оформление диалоговой документации и справоч
ного текста
Должен быть использован одноколонный формат
20