ВУЗ: Алтайский Государственный Университет
Категория: Учебное пособие
Дисциплина: Управление проектами
Добавлен: 23.10.2018
Просмотров: 874
Скачиваний: 11
1
СТАНДАРТИЗАЦИЯ ДОКУМЕНТИРОВАНИЯ ПРОЦЕССОВ И ПРОДУКТОВ
ПРОГРАММНЫХ СРЕДСТВ
Документация разработки (технологическая) описывает процесс разработки определяет
требования, которым должно удовлетворить ПС, определяет проект, как его контролируют и обеспечивают
качество. Документация разработки включает подробное техническое описание ПС (программную логику,
взаимосвязи, форматы хранение данных). Она является средством связи между всеми лицами, вовлеченными в
процесс разработки, описывает подробности решений принятых относительно требований к ПС, проекту,
программированию и тестированию, а также обязанности группы разработки — кто, что и когда делает,
учитывая роль объекта работ, документации, персонала, обеспечивающего качество, и каждого специалиста в
процессе разработки. Документация образует основу сопровождения — описывает историю разработки ПС.
Если документы разработки отсутствуют, неполны или устарели, руководители теряют важное средство для
отслеживания и контроля проекта.
Документация продукции (эксплуатационная) обеспечивает формацию, необходимую для
эксплуатации, сопровождения модернизации, преобразования и передачи программной продукции к
пользователю. Она обеспечивает учебную и справочную информацию для специалистов использующих или
эксплуатирующих программную продукцию; облегчает программистам не разрабатывающим ПС, его
сопровождение и модернизацию; помогает продаже приемке программной продукции. Документация
продукции, должна включать материалы: для пользователей, которые вводят данные, восстанавливают
информацию и решают задачи с помощью ПС для операторов, которые применяют и ПС на вычислительной
системе; для сопровождающих программистов, а также материалы для руководителей которые следят за
использованием комплекса программ. Типовые документы продукции включают: учебные руководства;
справочные руководства и руководства пользователей; руководства по сопровождению ПС; брошюры и
информационные листовки, посвященные рекламе продукции.
Документация управления проектом включает графики для каждой стадии процесса разработки и
отчеты об изменениях графиков; отчеты о согласованных изменениях программ; отчеты о решениях,
связанных с разработкой; распределение обязанностей специалистов. Руководители должны применять
стандарты, распространяющиеся на обеспечение качества, соответственно различными типами документов и
различным типам проектов, и должны определять, как это качество будет достигнуто и поддержано. Понятия
качества документации включает: качество содержания; структуру информации; представление проекта с
иллюстрациями.
Пользователей ПС можно разделить на две крупных группы, каждая из которых должна быть
обеспечена комплектной эксплуатационной документацией:
-
администраторы, подготавливающие ПС к эксплуатации и обеспечивающие их функционирование и
использование по прямому назначению;
-
операторы пользователи, реализующие функционирование и применение программных средств в
системе, обработку и анализ результатов.
Документация администрирования при эксплуатации системы должна обеспечивать поддержку
первичной инсталляции, безопасного функционирования и восстановления программ и данных после сбоев.
Администратор системы должен быть информирован о всех изменениях функционирования устройств
системы и внешней среды, могущих привести к сбою или возникновению аварийной ситуации, и
предпринимать соответствующие действия. для этого требуется полная информация о компонентах системы
(
компьютерах, сетевых устройствах) и внешней среды, которые имеют свои особенности в управлении с
помощью специальных программных средств, поддерживающих администрирование и управление системой и
ПС. К основным функциям системы администрирования относятся:
-
консультация разработчиков программ и данных по особенностям применения операционной
системы и системы управления базой данных (СУБД);
-
планирование использования памяти и производительности вычислительной системы в рабочем
режиме применения ПС;
-
инсталляция и генерация инструментальных средств и рабочей версии ПС для оперативного
пользователя;
-
выявление и регистрация сбоев и дефектов функционирования программ и данных,
-
управление, корректировка и учет внешней среды при реконфигурации конкретного ПС;
-
оперативное управление, учет и распределение ресурсов системы и компонентов ПС;
-
управление средствами защиты информации и санкционированный доступом пользователей, анализ
попыток взлома системы защиты;
-
защита и восстановление информации баз данных при дефектах и искажениях;
-
сбор статистики о функционировании системы обработки информации и ПС.
Описание эксплуатационной концепции для системы управления содержит описание действий
пользователя, необходимых для работы с предлагаемой системой и ПС, ее связи с существующими системами
2
и процедурами. данное описание используют при создании соглашения между поставщиком, разработчиком,
организацией, осуществляющей поддержку, и пользователями. данный документ фиксирует текущее
состояние системы, ее назначение, возможности и ограничения в зависимости от режима или конкретного
состояния эксплуатации (например, стандартный режим, сопровождение, обучение, снижение функций,
аварийные ситуации) и включает в себя описание:
-
конкретной эксплуатационной среды и ее характеристики;
-
основных компонентов системы и связей между ними;
-
внешних интерфейсов системы;
-
возможностей и функций системы;
-
таблиц и дополнительных графических представлений входов, выходов, потоков данных, а также
руководств, позволяющих разобраться в текущем состоянии системы с точки зрения пользователя:
-
состава персонала, его организационной структуры, технической подготовки, обязанностей,
взаимодействия;
-
уровней и циклов технического обслуживания;
-
форм регистрации обнаруженных дефектов;
-
соглашений о внесении изменений, возникающих в процессе сопровождения (их классификация и
порядок внесения, включая поставку необходимого оборудования и обучение персонала);
-
концепцию поставки новой или модифицированной версии, эксплуатационный сценарий;
-
информацию о взаимодействии пользователей, поставщика, разработчика и организации,
осуществляющей поддержку, во время эксплуатационного периода.
Стандарт ISO 9127 рекомендуется для создания пользовательской документации на коммерческие
пакеты (закрытые коробки) программных средств, поставляемых на рынок. Пользовательская и рекламная
документация на пакеты программ должна включать:
Общие сведения: введение; ограничения; область применения; определения; ссылки.
Пользовательская документация — инструкция по эксплуатации должна содержать описание, в
котором заключена вся информация, необходимая пользователю для установки, запуска и применения ПС.
Обычно эта документация представляет собой одно или несколько руководств, заключенных вместе с
носителями ПС внутри упаковки, В результате пользователи не могут ознакомиться с детальным
руководством до тех пор, пока пакет не куплен. Состав пользовательской документации раздел 1 стандарта
представлен в п. 7.10.
Описание целей и области применения публикуется на внешней упаковке пакета ПС. Его задачей
является дать возможность будущему покупателю оценить применимость ПС к своим по потребностям.
Структура этой информации представлена в разделе 2 данного стандарта (см. в. 7.10).
В Советском Союзе в 70-е годы была разработана Единая Система Программной документации
(
ЕСПД) в составе группы стандартов ГОСТ 19.ХХХ. Большинство этих стандартов устарело, не соответствует
современным требованиям и их применение не целесообразно. Более качественно стандартизация
документирования программ и данных отражена в некоторых стандартах по автоматизированным системам
ГОСТ 34.ХХХ, утвержденных в конце 80-х годов. В настоящее время наиболее полезно освоить и
использовать некоторые их фрагменты, которые можно отнести к документированию программ и данных, из
стандартов:
ГОСТ 34.201-89 Информационная технология. Виды, комплектность и обозначение документов при
создании автоматизированных систем;
ГОСТ
34.602-90
—
Информационная
технология.
Техническое
задание
на
создание
автоматизированных систем;
РД 50-34.698-90 Методические указания. Информационная технология. Автоматизированные системы.
Требования к содержанию документов.
СТРУКТУРА И СОДЕРЖАНИЕ – ШАБЛОНЫ ДОКУМЕНТОВ ПРОГРАММНЫХ СРЕДСТВ
1. Документы квалификационного тестирования, испытаний и оценивания качества
программных средств
1.1. Акт завершения работ по проекту программного средства:
•
идентификатор проекта и завершенной работы;
•
список представителей организации-разработчика и организации заказчика, составивших акт;
•
дата завершения проекта и работ;
•
перечень и наименования документов, на основании которых
•
осуществлен проект и проводилась работа:
•
перечень и наименования документов, содержащих обобщенные
•
результаты выполненного проекта ПС;
•
основные результаты завершенного проекта ПС;
3
•
заключение о результатах завершенного проекта и степени выполнения технического задания и
спецификаций требований к ПС с положительным или отрицательным итогом;
•
рекомендации по развитию и внедрению результатов проекта ПС;
•
приложения:
− комплект технологической и эксплуатационной документации на комплекс программ;
− исходные документы на разработку проекта ПС;
− полный отчет о результатах квалификационных испытаний ПС.
1.2. Акт приемки программного средства в промышленную эксплуатацию:
•
идентификатор системы и/или ПС, принимаемых в эксплуатацию;
•
сведения о статусе приемочной комиссии (государственная, межведомственная, ведомственная), ее
составе и основании для работы;
•
период времени работы комиссии приемки в эксплуатацию;
•
идентификаторы организации-разработчика, организации-соисполнителя и организации заказчика;
•
перечень и наименования исходных документов, на основании которых разработано ПС;
•
состав и описание функций ПС, принимаемых в эксплуатацию;
•
перечень и описание компонентов технического, программного,
•
информационного и организационного обеспечения, принимаемых в эксплуатацию;
•
перечень и наименования комплекса документов, предъявленных комиссии;
•
заключение о результатах опытной эксплуатации ПС;
•
оценка соответствия принимаемого ПС техническому заданию,
•
спецификации требований и контракт на его создание;
•
краткая характеристика и основные результаты выполненной работы по созданию ПС;
− оценка научно-технического уровня комплекса программ;
− оценка экономической эффективности от возможного внедрения комплекса программ;
•
решение комиссии о возможности принятия ПС в промышленную эксплуатацию;
•
рекомендации комиссии по дальнейшему развитию системы и комплекса программ;
•
приложения:
− Программа и протоколы испытаний;
− протоколы заседаний комиссии;
− перечень технических средств и характеристик внешней среды, которые использовала комиссия
при испытаниях и приемке ПС;
− справка о применении в ПС нормативных документов и унифицированных форм (шаблонов)
документов.
2. Документы процессов эксплуатации программных средств
2.1. Общее описание системы, в которой используется программное средство:
•
назначение и идентификатор системы:
− вид деятельности, для информатизации которой предназначена система;
− перечень объектов автоматизации и внешней среды, на которых используется система и ПС;
• описание системы:
− структура системы и назначение ее частей;
− сведения о программном продукте в целом и его частях, необходимые для корректной
эксплуатации системы;
− описание функционирования системы и ее частей;
•
описание взаимосвязей программного продукта с другими системами и ПС:
− перечень компонентов систем и ПС, с которыми связано данный программный продукт;
− описание регламента связей между системами и ПС;
− перечень функций, реализуемых каждой взаимодействующей системой и ПС.
•
краткое описание ПС, перечень файлов, включая базу данных и файлы со справочной информацией
для пользователей, описание аппаратуры и прочих ресурсов, необходимых для доступа и
использования программного продукта в полном объеме;
•
режимы работы программного продукта;
•
терминалы, принтеры и другие входные и выходные устройства;
•
необходимые процедуры, утилиты, в том числе процедуры для установки и инсталляции
программного продукта;
•
форматы представления входной и выходной информации, их назначение, тип, объем;
•
точность представления, скорость передачи, ожидаемое время реакции на операции пользователя;
4
•
способ задания конца обработанной информации и другие требуемые соглашения;
•
ограничения и наиболее типичные ошибки задания информации;
•
описание используемой системы управления базой данных.
2.2. Общие требования к формированию Пользовательской документации программных
средств по стандарту ISO 15910:1999 (ГОСТР-2002).
2.3.Описание административного управления программными средствами системы:
•
концепции и обзоры системного управления программами и базами данных;
•
документы, детализирующие концепцию процессов управления системой и ПС и требования к
реализации каждой функции;
•
информационная модель системы, комплекса программ, их атрибутов и операций;
•
руководства для формализации и описания объектов управления системы и ПС;
•
формализация непосредственной передачи управляющей информации между компонентами системы
и ПС;
•
документы, описывающие:
− передаваемые типы данных;
− формализованные объекты, их состояния, атрибуты, операции и извещения об обмене;
•
классификатор объектов управления, отражающий взаимосвязь между классами объектов
управления и правилами их применения;
•
функции администратора программных средств:
− общие функции администрирования при применении данного ПС;
− процедуры по инсталляции и подготовке ПС к эксплуатации;
− контроль ввода заданий и выработки запроса на их выполнение;
− контроль представления результатов обработки заданий;
− способы и формы контроля исполнения заданий;
− динамическое управление процессом реализации заданий.
2.4. Руководство системного администратора программного средства:
•
описание запуска системы управления и комплекса программ либо непосредственно с центрального
компьютера, либо другим централизованным способом, либо через сеть;
•
описание аппаратных и программных средств, требуемых для работы системы;
•
технические характеристики используемых аппаратных устройств;
•
структура, обзор назначения и функционирования каждого компонента комплекса программ;
•
перечень входных команд, команд доступа к ПС и реакции на выполнение;
•
аварийные сообщения и другие выходные данные, формируемые для контроля комплекса программ;
•
типовые времена выполнения основных функций ПС;
•
последовательность действий для запуска системы и комплекса программ;
•
перечень требуемых библиотек поддержки и интерфейсов системы;
•
форма и средства регистрации дефектов и ошибок, возникающих в процессе эксплуатации ПС;
•
перечень процедур, выполняемых системным администратором при установке ПС для конкретного
выбранного окружения и конкретной конфигурации системы.
2.5. Общее описание руководства пользователей программного средства:
•
порядок действий пользователя для установки и использования системы и ПС;
•
краткое описание функций и характеристик ПС;
•
описание внешней программной среды;
•
перечень файлов, включая файлы базы данных, необходимых для применения ПС;
•
порядок действий для продолжения или возобновления функционирования ПС в случаях
возникновения непредвиденных ситуаций;
•
организация и функционирование ПС с точки зрения пользователя;
•
описание процедур, позволяющих фиксировать дефекты и ошибки;
•
детальные, пошаговые действия пользователя при включении системы и дальнейшей работе с ней;
•
ссылки на другие руководства системы и комплекса программ;
•
перечень и пояснение выводимых системой сообщений.
2.6. Руководство оперативного пользователя программного средства:
•
титульный лист, оформленный по правилам предприятия с учетом требований заказчика;
•
ограничения на применение документа и указания на авторские права на программный продукт;
•
введение:
− область применения ПС;
− краткое описание функциональных возможностей;
5
− требования к уровню подготовки пользователя;
− перечень эксплуатационной документации, с которыми необходимо предварительно ознакомиться
пользователю;
•
назначение и условия применения комплекса программ:
− теоретические основы данного комплекса программ, функции и решаемые задачи;
− виды деятельности и функции, для автоматизации которых предназначено данное программное
средство;
− условия, при соблюдении (выполнении, наступлении), которых обеспечивается применение
программного средства в соответствии с назначением, спецификациями требований и
характеристиками системы;
− технические и административные операции для запуска решения функциональных задач;
− предостережения и предупреждения от ошибок пользователей;
− метод решения каждой задачи, их взаимодействие и ограничения;
•
подготовка к работе:
− состав и содержание дистрибутивного носителя комплекса программ и данных;
− описание всех выполняемых функций, задач, процедур;
− описание операций технологического процесса обработки данных, необходимых для выполнения
функций, комплексов задач, процедур;
− порядок загрузки данных и программ;
− порядок контроля и проверки работоспособности комплекса программ;
•
описание функциональных операций ПС для каждой операции обработки данных должно быть
указано:
− идентификатор и наименование операции;
− условия, при соблюдении которых возможно выполнение операции;
− подготовительные действия;
− основные действия в требуемой последовательности функциональных операций;
− исходные данные, необходимые для корректного функционирования комплекса программ;
− информация для контроля корректного функционирования комплекса программ;
− рекомендации как приостановить исполнение заданных функций и провести рестарт комплекса
программ;
− регистрация окончание исполнения заданной функции комплекса программ;
− заключительные действия для завершения требуемой задачи;
− оценка ресурсов, расходуемых на операцию или заданную функцию;
• аварийные ситуации:
− действия пользователя в случае несоблюдения условий выполнения технологического процесса, в
том числе при отказах технических средств;
− действия пользователя по восстановлению программ и/или данных при отказе или обнаружении
ошибок;
− действия в случаях обнаружения несанкционированного вмешательства в данные;
•
гарантии и обязательства по контракту на комплекс программ, а также условия отказа от них;
•
рекомендации по обучению и освоению ПС, включая описание контрольного примера, правила его
запуска и выполнения;
•
приложения детальные сведения о форматах исходных и результирующих данных, структуре файлов
и экранов.
2.7. Инструкция по формированию и ведению информации базы данных:
• правила подготовки информации данных:
− порядок отбора информации для включения в базу данных;
− правила подготовки и кодирования информации базы данных;
− формы ее представления и правила заполнения этих форм;
− порядок внесения изменений в информацию базы данных;
• порядок и средства заполнения базы данных:
− состав технических средств;
− правила, порядок, последовательность и описание процедур, используемых при заполнении базы
данных, включая перенос данных на машинные носители информации;
• процедуры изменения и контроля информации базы данных:
− состав и последовательность выполнения процедур по контролю и изменению содержания базы
данных;