Электронный фонд правовой
и нормативно-технической документации
ГОСТ Р ИСО/МЭК 15910-2002 Информационная технология (ИТ). Процесс создания документации пользователя программного средства
ГОСТ Р ИСО/МЭК 15910-2002
Группа П85
ГОСУДАРСТВЕННЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ
ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ
ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
Information technology.
Software user documentation process
ОКС 35.080
ОКСТУ 5001
Дата введения 2003-07-01
Предисловие
1 РАЗРАБОТАН И ВНЕСЕН Всероссийским научно-исследовательским институтом стандартизации (ВНИИстандарт) Госстандарта России
2 ПРИНЯТ И ВВЕДЕН В ДЕЙСТВИЕ Постановлением Госстандарта России от 25 июня 2002 г. N 249-ст
3 Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 15910-99 "Информационная технология. Процесс создания документации пользователя программного средства"
Введение
Существующие стандарты можно отнести к двум основным типам:
a) стандарты на продукцию, определяющие ее характеристики и требования к ней;
b) стандарты на процессы, определяющие конкретные методы создания продукции.
Возрастающий масштаб применения программных средств и их сложность вызывает необходимость наличия полной, точной и понятной документации на эти средства, доступной пользователям. Настоящий стандарт определяет способ достижения данной цели, устанавливая работы (что должно быть сделано и исполнителя), связанные с качеством документации пользователя программных средств.
Документация часто рассматривает нечто, разрабатываемое после создания конкретного программного средства. Однако с точки зрения качества разработки программной документации она должна рассматриваться как неотъемлемая часть процесса создания данного программного средства. При надлежащем подходе к данной проблеме требуется достаточно сложная работа по планированию документирования. Целью настоящего стандарта является стимулирование разработчиков программных средств к надлежащему использованию процесса документирования. Стандарт также представляет пользователям метод определения надлежащего применения процесса документирования при создании конкретного программного средства.
Основной работой по настоящему стандарту является создание комплексного плана разработки документации, реализация которого обеспечивает лучшее документирование программного средства. Для соответствия настоящему стандарту данный план должен включать в себя требования (спецификацию) к стилю оформления документов. Настоящий стандарт не определяет состав данных требований (то есть компоновку конкретного документа или используемый шрифт), но устанавливает их диапазон. Стандарт также определяет виды информации, представляемой заказчиком разработчику документации (документатору) для проверяющих и распространяющих документацию.
Более подробная информация по данному вопросу приведена в библиографии.
1 Основной стандарт дополнен справочными приложениями, библиографией и тематическим указателем.
2 Исходный стандарт ИСО/МЭК 15910 разработан на основе австралийского стандарта AS 4258:1994.
3 Перечень дополнительных публикаций, связанных с тематикой настоящего стандарта, приведен в библиографии (см. [1]-[21]).
1 Область применения
Настоящий стандарт определяет минимально необходимый процесс создания документации пользователя всех видов для программного средства, имеющего интерфейс пользователя. Данные виды охватывают печатную документацию (например, руководства пользователя и краткие справочные карты), диалоговую (оперативную) документацию, справочный текст ("хелпы") и системы диалоговой документации.
Стандарт соответствует требованиям 6.1 ГОСТ Р ИСО/МЭК 12207.
Применение настоящего стандарта должно обеспечить разработку документации, удовлетворяющей потребностям пользователя.
Стандарт предназначен для разработчиков и потребителей документации пользователя.
Настоящий стандарт используется для печатной документации, а также для справочных экранов, справочной системы обеспечения поставки, справочной информации и т.д.
Стандарт предназначен для применения при двусторонних отношениях и может быть использован, если обе стороны корпоративно связаны. Стандарт также может быть использован одной из сторон для самоконтроля.
Примечание - В приложении В приведены более подробные рекомендации по применению настоящего стандарта в договоре между заказчиком и разработчиком документации.
2 Соответствие
Доступ к полной версии документа ограничен
Документ «ГОСТ Р ИСО МЭК 15910 2002» определяет требования к процессу создания документации пользователя для программного обеспечения. Основное назначение стандарта заключается в обеспечении единых подходов к разработке и оформлению пользовательских руководств, что способствует повышению качества документации и удобству её использования. Сфера применения охватывает различные виды программных средств, включая коммерческие и специализированные решения, что делает стандарт актуальным для широкой аудитории.
Ключевыми аспектами, регламентируемыми данным стандартом, являются методы разработки документации, требования к структуре и содержанию пользовательских материалов, а также процедуры валидации и тестирования документации. Стандарт также описывает параметры, которые должны быть учтены при создании документации, такие как уровень сложности программного обеспечения, целевая аудитория и предполагаемые сценарии использования. Это позволяет разработчикам адаптировать документацию в соответствии с потребностями конечных пользователей.
Технические детали, указанные в стандарте, включают рекомендации по форматированию текста, использованию графических элементов и организации информации. Важным аспектом является определение условий испытаний документации, что позволяет оценить её соответствие установленным требованиям. Также стандарт предлагает классификацию типов документации, что упрощает процесс её создания и управления.
Целевая аудитория стандарта включает разработчиков программного обеспечения, специалистов по технической документации, а также контролирующие и сертифицирующие организации. Это делает стандарт полезным инструментом как для производителей, так и для лабораторий, занимающихся тестированием и оценкой качества программных продуктов. Таким образом, стандарт способствует улучшению взаимодействия между разработчиками и пользователями, а также повышению уровня доверия к программному обеспечению.
Практическое значение стандарта заключается в его влиянии на безопасность, качество и совместимость программного обеспечения. Стандартизация процесса создания документации позволяет минимизировать риски, связанные с неправильным использованием программных продуктов, а также повышает общую удовлетворённость пользователей. При этом соблюдение требований стандарта способствует улучшению охраны труда, так как чёткая и понятная документация снижает вероятность ошибок при работе с программным обеспечением.
В документе могут быть указаны изменения или дополнения, касающиеся новых методов и технологий, применяемых в процессе создания документации. Эти обновления направлены на адаптацию стандарта к современным требованиям и условиям, что делает его актуальным в условиях быстроменяющейся информационной среды. В целом, соблюдение данного стандарта способствует повышению качества документации и облегчает процесс её использования конечными пользователями.
Описание документа носит справочный характер, достоверность этого материала не гарантируется.
Чтобы получить полный доступ к этому и другим документам, приобретайте доступ к Информационной сети «Техэксперт» - лидеру в области комплексного обеспечения предприятий нормативно-технической документацией.
доступны в системах «Техэксперт» и «Кодекс»
Возможно вас заинтересуют
РД 153-39.4-075-01 Правила капитального ремонта магистральных нефтепродуктопроводов на переходах через водные преграды, железные и автомобильные дороги I-IV категорий
РД 153-39.4-073-01 Типовой план ликвидации возможных аварий на магистральных нефтепродуктопроводах
МДС 81-30.2002 Временные методические указания по определению стоимости работ при строительстве и ремонте автомобильных дорог
Изменение N 1 ГОСТ Р 51110-97 Средства защитные банковские. Общие технические требования
Изменение N 1 ГОСТ Р 51111-97 Средства защитные банковские. Правила приемки и методы испытаний
Изменение N 2 ГОСТ Р 51112-97 Средства защитные банковские. Требования по пулестойкости и методы испытаний