ЛитВек: бестселлеры недели
Бестселлер - Михаил Александрович Шолохов - Тихий Дон - читать в ЛитвекБестселлер - Маршалл Розенберг - Язык жизни. Ненасильственное общение - читать в ЛитвекБестселлер - Иринья Коняева - (Не)счастье для морского принца - читать в ЛитвекБестселлер - Габриэль Гарсия Маркес - Сто лет одиночества - читать в ЛитвекБестселлер - Татьяна Владимировна Мужицкая - Брать, давать и наслаждаться. Как оставаться в ресурсе, что бы с вами ни происходило - читать в ЛитвекБестселлер - Антонио Катифоро - Жизнь Петра Великого - читать в ЛитвекБестселлер - Александр Владимирович Бурьяк (Bouriac) - Антон Чехов как оппонент гнилой российской интеллигенции - читать в ЛитвекБестселлер - Саймон Дженкинс - Краткая история Европы - читать в Литвек
Литвек - электронная библиотека >> ГОССТАНДАРТ РОССИИ >> Программирование: прочее и др. >> Информационная технология. Процесс создания документации пользователя программного средства >> страница 3
средств, устройств, обслуживаемый персоналом и обладающий возможностью удовлетворять установленным потребностям и целям (3.31 ГОСТ Р ИСО/МЭК 12207).

4.45 содержание (table of contents): Указатель заголовков издания с указанием номеров страниц в порядке их возрастания.

4.46 таблица действующих страниц (лист изменений) (table of effective pages): Перечень последних версий номеров каждой замененной страницы бумажного документа. При замене отдельных страниц в перечне указывают старые и новые номера страниц.

4.47 план выбора группы проектантов (team selection plan): Документ, устанавливающий требования к квалификации и опыту персонала, разрабатывающего документацию.

4.48 страница-развертка (throwclear): Страница-раскладка, выполненная таким образом, что в развернутом виде и закрытом издании (книге, руководстве) доступна для обозрения (чтения) совместно с предыдущими страницами.

4.49 практическая лаборатория (usability laboratory): Комплекс аналитических и исследовательских помещений, оснащенных видео- и аудиооборудованием для регистрации ответов на запросы пользователей.

4.50 тестирование на практичность (usability testing): Формальный процесс оценки соответствия документации установленным требованиям.

4.51 интерфейс пользователя (user interface): Интерфейс, обеспечивающий возможность обмена информацией между человеком и техническими или программными компонентами вычислительной системы.

4.52 пользователь (user): Лицо или организация, которые используют действующую систему для выполнения конкретной функции (3.34 ГОСТ Р ИСО/МЭК 12207).

Примечание — см. также 4.3.

4.53 разворот (листа) (verso): Две смежные страницы раскрытого издания, левая и правая.

4.54 разделитель активный (white space, active): Пространство (за исключением полей), охватывающее текстовые и графические элементы, разделяющее текст, отделяющее тематические и подтематические составляющие текста, указывающее в тексте тематические и иерархические отношения, выделяющее соответствующую информацию и облегчающее чтение текста.

4.55 разделитель пассивный (white space, passive): Верхнее, нижнее, левое и правое поля, окружающие текст.

4.56 начальная висячая строка (widow): Первая строка части текста (главы, раздела и т. д.), завершающая последнюю строку на странице (полосе).

5 Управление качеством

Если разработку программного средства документируют в соответствии со стандартом по управлению качеством, положения данного стандарта в равной мере применяют как к самой разработке, так и к соответствующей документации.

Примечание — Даже если стандарт по управлению качеством не указан в договор (контракте), документаторы стремятся использовать систему управления качеством, аттестованную на соответствие дан-ному(ым) стандарту(ам). Относительно качества программного средства в целом см. ГОСТ Р ИСО/МЭК 12119.

6 Адаптация

Настоящий стандарт определяет одну из реализаций процесса документирования, описанного в ГОСТ Р ИСО/МЭК 12207, и может быть адаптирован к условиям конкретных проектов (см. приложение В).

7 Цели

Настоящий стандарт по существу является стандартом на процесс. Стандарт не определяет компоновку конкретного документа, его содержание и другие аспекты комплектности документации, однако он устанавливает метод планирования и проведения процесса документирования.

8 Требования

8.1 Процесс документирования

8.1.1 Общие положения

Процесс документирования должен быть выполнен в два этапа в последовательности, представленной на рисунке 1 в затененных прямоугольниках. Поэтапные работы не выполняются одновременно. На отдельных этапах работы могут проводиться параллельно. Возможные итерации работ показаны пунктирными линиями.

Когда минимальный состав документации определяется заказчиком (например, с использованием ГОСТ Р ИСО 9127 или ИСО/МЭК 6592 [1]), это должно быть учтено документатором при разработке плана документирования.

8.1.2 Представление исходных материалов

Заказчик должен обеспечивать документатору доступ:

a) ко всем соответствующим спецификациям, форматам записей, компоновкам экранов и отчетов, выходным результатам работы средств автоматизации программирования (CASE tool) и другой информации, необходимой для подготовки документации;

b) к рабочей копии программного средства (при необходимости);

c) к аналитикам и программистам, включая своевременное правильное решение вопросов, возникающих у персонала разработчиков документации;

d) к типичным пользователям (по возможности) для анализа аудитории и тестирования напрактичность.

В обязанности документатора входит обеспечение плодотворности контактов с разработчиками программных средств заказчика, гарантирующее как минимум понимание сути выпускаемой продукции и соответствующих ей аудиторий.

Примечание — Документатор не отвечает за разработку, проверку или корректировку исходных материалов, а только за их получение.

Независимо от того, является ли документатор одновременно разработчиком программного средства, заказчик должен обеспечить его копиями всех применяемых стандартов, руководствами по стилям и форматам, а также соответствующими материалами (если они не являются общедоступными). Документатор должен обеспечить данными материалами соответствующий персонал разработчиков документации.

Обязанностью разработчика является обеспечение полноты, правильности и актуальности всех материалов, предъявляемых разработчику на момент их поставки.

Разработчик должен гарантировать, что представление документатору данных материалов не нарушает прав интеллектуальной собственности любой третьей стороны.

Документатор должен предпринять соответствующие шаги по сохранению материалов, представленных заказчиком, обеспечить защиту информации о требованиях заказчика и возвратить все материалы заказчику по завершении проекта документирования.

Примечание — В ряде случаев нет необходимости возвращать все материалы; данный вопрос должен быть оговорен в договоре. В ряде случаев требуется сохранить конфиденциальность и секретность предоставленных материалов. В договоре должны быть установлены уровни (грифы) конфиденциальности или секретности материалов, представляемых заказчиком документатору.

Информационная технология. Процесс создания документации пользователя программного средства. Иллюстрация № 1 Рисунок 1 — Обзор процесса документирования