ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА

Существующие стандарты можно отнести к двум основным типам:

a) стандарты на продукцию, определяющие ее характеристики и требования к ней;

b) стандарты на процессы, определяющие конкретные методы создания продукции.

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

Документация часто рассматривает нечто, разрабатываемое после создания конкретного программного средства. Однако с точки зрения качества разработки программной документации она должна рассматриваться как неотъемлемая часть процесса создания данного программного средства. При надлежащем подходе к данной проблеме требуется достаточно сложная работа по планированию документирования. Целью настоящего стандарта является стимулирование разработчиков программных средств к надлежащему использованию процесса документирования. Стандарт также представляет пользователям метод определения надлежащего применения процесса документирования при создании конкретного программного средства.

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

Более подробная информация по данному вопросу приведена в библиографии.

Примечания

1 Основной стандарт дополнен справочными приложениями, библиографией и тематическим указателем.

2 Исходный стандарт ИСО/МЭК 15910 разработан на основе австралийского стандарта AS 4258:1994.

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

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

Стандарт соответствует требованиям 6.1 ГОСТ Р ИСО/МЭК 12207.

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

Стандарт предназначен для разработчиков и потребителей документации пользователя.

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

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

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

Соответствие настоящему стандарту определяют по результатам демонстрации выполнения реализацией процесса, описанного в разделе 8.

В настоящем стандарте использованы ссылки на следующие стандарты: ГОСТ 2.301-68 Единая система конструкторской документации. Форматы ГОСТ Р ИСО 9127-94 Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов

ГОСТ Р ИСО/МЭК 12119-2000 Информационная технология. Пакеты программ. Требования к качеству и тестирование