|
Общие сведения
Возрастающие масштабы применения ПС и их сложность вызывают необ- ходимость в полной, точной и понятной документации на ПС, доступной поль- зователям. Часто документация разрабатывается после создания соответствую- щего ПС. Однако с точки зрения ее качества необходимо, чтобы она создава- лась в процессе разработки ПС.
С учетом этого в 1999 г. введен в действие международный стандарт ISO/IEC 15910:1999 – Информационная технология – Процесс создания до- кументации пользователя программного средства [40]. В России аутентич- ный стандарт ГОСТ Р ИСО/МЭК 15910–2002 действует с 2003 г. [7].
Стандарт ИСО/МЭК 15910 определяет одну из реализаций процесса доку- ментирования, описанного в ИСО/МЭК 12207 (см. п. 2.3.1 пособия), и предос- тавляет пользователю метод применения данного процесса при создании кон- кретного ПС. Стандарт содержит структуру комплексного плана разработки документации, однако не определяет состав требований к стилю оформления документов, устанавливая только их диапазоны.
Стандарт ИСО/МЭК 15910 должен использоваться при создании пользова- тельской документации всех видов:
печатной документации (руководство пользователя, краткие справочные карты);
диалоговой (оперативной) информации;
справочного текста (Help);
системы диалоговой документации. Стандарт имеет следующую структуру:
Область применения.
Соответствие.
Нормативные ссылки.
Определения.
Управление качеством (документации).
Адаптация.
Цели.
Требования (к процессу документирования).
Приложение А (справочное). Перекрестные ссылки с ИСО/МЭК 12207. Приложение В (справочное). Использование настоящего стандарта в дого-
воре.
Приложение С (справочное). Образец плана документирования. Докумен- тация пользователя для системы АВС – административного управления маг-
нитными лентами.
Приложение D (справочное). Отношения между аудиториями, выданными заданиями, бумажной и диалоговой документацией.
Приложение Е (справочное). Рекомендации по написанию на английском языке документации, подлежащей последующему переводу.
Приложение F (справочное). Оценка проекта (документации). Приложение G (справочное). Оценка плана документирования. Приложение H (справочное). Образец спецификации стиля.
Основные определения
Стандарт ИСО/МЭК 15910 использует следующие основные определения.
Аудитория (audience): категория пользователей, предъявляющих к доку- ментации одинаковые или аналогичные требования, определяющие содержа- ние, структуру и назначение данной документации.
Документатор (documenter): сторона, создающая документацию.
Справочный текст (help text): текст, автоматически выбираемый в зависи- мости от контекста, в котором он вызывается, облегчающий и убыстряющий при эксплуатации ПС поиск содержащихся в издании объектов. Справочный текст контекстно зависим.
Диалоговая документация (on-line documentation): информация, доступная пользователю при эксплуатации ПС, которая необязательно привязана к кон- кретному контексту.
Система диалоговой информации или справочная система (on-line docu- mentation system or help system): часть программы или отдельная программа, за- прашиваемая пользователем и позволяющая ему просматривать части диалого- вой документации или справочного текста.
Продукт (программный продукт, product): полный набор компьютерных программ, процедур и соответствующих им документации и данных, предна- значенный для поставки пользователю.
Тестирование на практичность (usability testing): формальный процесс оценки соответствия документации установленным требованиям.
Требования к процессу документирования
Процесс документирования должен выполняться в два этапа в соответст- вии с рис. 42. Работы, выполняемые в пределах этапа, могут производиться па- раллельно. Работы, выполняемые в различных этапах, должны осуществляться последовательно. Пунктирными линиями показаны возможные итерации работ. В скобках на рисунке указаны исполнители работ.
Рис. 42. Процесс документирования в соответствии со стандартом ГОСТ Р ИСО/МЭК 15910–2002
Из данного рисунка видно, что стандарт ИСО/МЭК 15910 регламентирует процесс документирования, частично отличающийся от соответствующего процесса, описанного в стандарте ИСО/МЭК 12207 (см. рис. 14 пособия). Связь задач процесса документирования из стандарта ИСО/МЭК 12207 (табл. 18 по- собия) с пунктами стандарта ИСО/МЭК 15910 приведена в Приложении А по- следнего.
Для получения исходных материалов (первая работа на рис. 42) заказчик должен обеспечивать документатору доступ ко всем материалам проекта, необ- ходимым для подготовки документации, к рабочей копии ПС, аналитикам, про- граммистам и пользователям, а также к копиям применяемых стандартов и ру- ководств по стилю и форматам.
Документатор должен разработать план документирования (вторая ра- бота на рис. 42), в котором должны быть определены задания, выполняемые при создании конкретной документации. План документирования должен охва- тывать комплект документации по всем необходимым видам (см. подразд. 6.1).
В плане документирования должны быть определены область применения, ограничения по использованию, основные решения, касающиеся анализа и про- ектирования документации, а также процедуры и проверки, выполняемые при разработке документации.
План документирования должен включать определение аудиторий пользо- вателей документации, уровня их образования, способностей, подготовки, опы- та и других характеристик, связанных с содержанием, структурой и использо- ванием документации. Каждый тип пользователей должен быть определен от- дельно.
При разработке плана документирования следует учитывать последова- тельность проектирования документации, описанную в Приложении D стан- дарта ИСО/МЭК 15910. Данная последовательность включает следующие эта- пы:
анализ пользователей документируемой системы и их объединение в аудитории в соответствии с потребностями пользователей (примеры аудиторий: квалифицированный пользователь, неквалифицированный пользователь, опера- тор);
определение заданий, выполняемых каждой аудиторией при работе с ПС; задания удобно представлять в виде иерархической структуры;
определение перечней потребностей каждой аудитории в информации; перечень потребностей определяется из заданий аудитории; на основе перечней определяется содержание конкретных документов.
После официального согласования плана документатор несет ответствен- ность за его контроль, распространение и последующие изменения. При этом необходимо предусмотреть процедуры аудита всех обновляемых копий плана.
Содержание плана документирования приведено в подразд. 6.4 пособия. Пример плана документирования приведен в Приложении С стандарта ИСО/МЭК 15910.
Do'stlaringiz bilan baham: |
