СТ РК ИСО/МЭК 6592 РУКОВОДСТВО ПО ДОКУМЕНТИРОВАНИЮ КОМПЬЮТЕРНЫХ ПРИКЛАДНЫХ СИСТЕМ
ГОСУДАРСТВЕННЫЙ СТАНДАРТ РЕСПУБЛИКИ КАЗАХСТАН ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ 1 Область применения Настоящий стандарт предоставляет руководство по документированию информационных систем (ИС) и предназначен для использования в этой сфере. Настоящий стандарт применим для программного обеспечения ИС. В то же время рассматривает и некоторые аспекты технических средств, например конфигурацию системы. Настоящий стандарт не является руководством по организации или структурированию документов. Он обеспечивает контрольный список для двух сторон, договаривающихся о содержании документа. Инструкции, представленные в настоящем стандарте, разработаны для: - достижения необходимых обязательств сторон, связанных с жизненным циклом ИС, для участия в процессе разработки;
- содействия созданию хорошо спланированных, стандартизированных документов системы программного обеспечения;
- обеспечения возможности разработки документов системы программного обеспечения параллельно с жизненным циклом программного обеспечения.
Однозначно определенные правила для документов в течение жизненного цикла программного обеспечения облегчают: - обеспечение соответствующей информацией;
- непосредственно подготовку документации;
- расчет времени и средств, требуемых для реализации проекта;
- обмен информацией между заинтересованными сторонами, приводящий к:
- выбору достижимых целей для системы;
- более завершенному и обдуманному функциональному дизайну;
- меньшему количеству недоразумений и ошибок;
- принятие решений и инструктаж персонала в течение жизненного цикла программного обеспечения.
Настоящий стандарт разработан таким образом, чтобы быть применимым к целому ряду ИС и предполагает, что компоненты программного обеспечения системы могут изменяться по сложности в достаточно широком диапазоне. Издание официальное Настоящий стандарт применяется к документам на любом естественном языке, и не зависит от средств, используемых для его выполнения, т.е., принципы в целом применимы, но в некоторых случаях могут иметься разногласия в структуре и формате. Хотя настоящий стандарт предназначен, в основном, для использования в сфере проектирования программного обеспечения (software engineering - SE), он также может применяться другими группами, менее относящимися к SE, включая группы, связанные со стратегией SE, разработчиков SE, заказчиков SE и пользователей SE. Настоящий cтандарт имеет большую значимость для этих групп, которые могут создавать некоторые из документов (например, стратегии, требования заказчика и документы пользователя). Связанная с SE деятельность предполагает использование методов, техники и инструментальных средств, которые имеют собственные средства документирования. Разработчики программного обеспечения могут использовать документы этого типа, но должны соблюдать принципы и практику, предложенные настоящим стандартом. 2 Нормативные ссылки В настоящем стандарте использованы ссылки на следующие стандарты: ГОСТ ИСО 9127:1988, Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных продуктов. ГОСТ ИСО/МЭК 12207:1995, Информационная технология. Процессы жизненного цикла программных средств. 3 Определения В настоящем стандарте применяются следующие термины с соответствующими определениями: 3.1 Документ: однозначно определенная единица информации для общественного использования, такая как доклад, спецификация, справочник или книга. 3.2 Документирование: составление одного или нескольких документов. 3.3 Информационная единица (подпункт): определенная группа информационных элементов. Примечание - Подпункт является частью информационной единицы. 3.4 Профиль документации: таблица информационных единиц, описывающая содержание одного или нескольких документов. 3.5 Условная информация: информация, прилагаемая с каждым блоком, к которому она относится. 3.6 Необязательная информация: информация, предоставленная по усмотрению производителя или торговой организации. 4 Применение стандарта Настоящий стандарт может использоваться для документов в ряде сфер SE. Его основным назначением является документирование системы программного обеспечения в ходе разработки, но он может применяться и в других аспектах жизненного цикла, например, при сопровождении системы, работе системы и формировании группы разработчиков проекта. Настоящий стандарт обеспечивает подготовку документов для любой модели жизненного цикла и не зависит от модели или методологии. Для жизненного цикла с рядом взаимосвязанных фаз, где документы обеспечивают средства информации между смежными фазами, документирование обеспечивает учет точно выполняемой работы. Для повторяющегося жизненного цикла, где некоторые процессы разработки повторяются, перед началом очередного этапа разработки, документы могут отражать возрастающую детализацию, или же уровень детализации может оставаться постоянным. Для параллельного или моделируемого развития жизненного цикла, где отдельные группы работают параллельно над разработкой аспектов системы программного обеспечения, документирование образует связь между группами или моделями и определяет информационные единицы, используемые для сообщения информации и требуемого уровня детализации. Руководство по процессам жизненного цикла представлено в ГОСТ ИСО/МЭК 12207. Если применяется данный стандарт, возможно, потребуется некоторая корректировка информационных единиц, перечисленных в настоящем стандарте. 4.1 Цель документирования Существует четыре основные цели документирования: - описывать и записывать информацию о системе на протяжении ее жизненного цикла;
- способствовать простоте использования и удобству сопровождения ИС;
- содействовать контролю над процессом жизненного цикла;
- сообщать информацию о системе тем, кто в ней нуждается.
4.2 Принципы документирования Основной принцип документирования заключается в установлении всех типов пользователей документов системы, термин пользователь в данном контексте включает в себя не только конечных пользователей программных средств, а также разработчиков, испытателей и других людей, использующих документы, подготовленные в течение процесса разработки. Установив все различные типы пользователей (стандарт обращается к этим пользователям позже как "аудитория"), необходимо подумать об их потребностях в информации. Конечные пользователи так же, как и разработчики, будут нуждаться в различной информации, в зависимости от выполняемого задания. Имеется ряд хорошо разработанных методик для облегчения процесса документирования. Настоящий стандарт не зависит от использования какой-либо особенной методики. Документы, удовлетворяющие потребностям пользователя, требуют планирования. Достигнув соглашения по перечню информационных единиц, используйте профиль документации, чтобы отнести эти единицы информации к специфическим документам. Документы, описанные в настоящем стандарте, могут быть записаны в любой среде. Некоторые документационные методики помогут в определении соответствующей среды документа, планирования и структуры. 4.3 Применение стандарта к системе программного обеспечения 4.3.1 Общее применение. Для применения настоящего стандарта, должны быть определены информационные потребности пользователей документов. Эти потребности должны быть указаны в профиле документации (см. п.5.2) с описанием информационных единиц. Подготовка профиля документации необходима для установления содержания документов, образующих полный комплект системной документации. Заказчик и поставщик должны согласовать профиль, чтобы имелось предварительное понимание содержания документационного набора, который будет поставлен заказчику. Разработка профиля документации даст возможность обеим сторонам договориться о названии и содержании документа. Содержание и сложность документов будут зависеть от применения системы программного обеспечения и аудитории пользователей документов, определенных в профиле. Информационные единицы, необходимые для определения содержания и сложности документов, представлены в трех уровнях. Эти уровни могут использоваться в различных аспектах, таких как: - информационные единицы 1-го уровня могут потребоваться в сводных документах или на ранней стадии жизненного цикла. Информационные единицы 2 и 3-го уровней могут потребоваться в более детализированных документах или на поздней стадии жизненного цикла;
- информационные единицы 1-го уровня могут потребоваться в простых системах, где нет необходимости в детализированных документах;
- информационные единицы 2 и 3-го уровней могут потребоваться для систем программного обеспечения, которые считаются более уязвимыми.
Настоящий стандарт может применяться как для определения особых видов документов и их содержания, так и для проверки сложившегося набора типов документов, соответствующего настоящему стандарту. 4.3.2 Описание содержания документа. Для завершения описания профиля документации следует предпринять следующие шаги: - установить, какие документы нужны на протяжении жизненного цикла. Названия этих документов должны быть указаны параллельно верхней части графы в документации;
- просмотреть содержание каждой информационной единицы, чтобы определить необходимость ее наличия в документе. Установить тип информации: основная (О), условная (У) или необязательная (Н).
Проверьте информационные единицы на разных уровнях их описания для того, чтобы определить какой уровень необходим для документа, и впишите код (О, У или Н) в требуемый уровень документации. Рекомендуется разъяснять содержание с использованием примеров. В определенных обстоятельствах более приемлемо определять документ, указывая информационные единицы, включенные в документ, до завершения профиля документации для этого документа. Это будет уместно в случае, когда заказчик желает определить контрольную таблицу содержания документа. В качестве альтернативы, список пунктов и подпунктов может использоваться для определения документа, не содержащего полный набор подпунктов, идентифицированных в настоящем стандарте для данного уровня детализации. 4.3.3 Обзор содержания существующего документа. Настоящий стандарт также может использоваться для обзора документов из комплекта существующей документации с целью установления их соответствия настоящему стандарту. Этот процесс может способствовать сверке документов из комплекта существующей документации. Обзор может осуществляться следующим образом: - подготовка сравнительной таблицы с номерами параграфов и названиями существующих документов, перечисленных на одной стороне, и колонка на другой стороне, в которую будут включены номера пунктов из описания информационных единиц;
- определение информационной единицы в комплекте существующей документации и обзор перечня информационных единиц в описании информационных единиц;
- определение информационной единицы соответствующей информационной единице в комплекте существующей документации. Впишите номера соответствующих информационных единиц в колонку возле соответствующего номера параграфа и названия из существующего набора документации;
Примечание - Несколько номеров могут относиться к одному номеру параграфа и названию в комплекте документации. - отметьте любые информационные единицы в комплекте существующей документации, не имеющие соответствующих информационных единиц в настоящем стандарте;
- проверьте другие информационные единицы в настоящем стандарте, чтобы удостовериться, что все необходимые информационные единицы включены в документы.
4.4 Ограничения Специфический документ или информационная единица может не иметь отношения к одной системе и иметь значение для другой. Профиль документации, разработанный с использованием настоящего стандарта, может применяться для того, чтобы удостовериться в том, что если информация не включена в документацию, то это является результатом позитивного решения, а не следствием недосмотра. Поэтому, применяя данный стандарт, следует принять во внимание следующие указания, ограничивающие использование информационных единиц в создаваемых документах: - завершенность: каждая информационная единица, требуемая для профиля документации, должна быть включена в комплект документации системы, в противном случае следует указать причину, почему она не была включена;
- значимость: необходимо предоставить обоснование для включения данной информационной единицы в профиль документации (для специфического документа);
- степень детализации: в одном и том же документе могут встречаться различные степени детализации для данной информационной единицы.
4.5 Обеспечение соответствия требованиям заказчика Настоящий стандарт устанавливает структуру, в которой документы определяются с помощью использования иерархических профилей для определения информационных единиц документов системы программного обеспечения, и сосредотачивается на информационных единицах, в основном для разработки программ и данных. Настоящий стандарт может быть приспособлен путем дополнений, изменений и исключений информационных единиц по мере необходимости, так долго пока используется та же структура. 5 Метод документирования 5.1 Обзор описания информационных единиц Обзор представлен в качестве трехструктурного каталога на рисунке 1. Каталог содержит названия и номера информационных единиц, подробно изложенных в описании информационных единиц (п. 5.3 и 5.4). Номера и названия пунктов, указанные под заголовком «Структура», являются заголовками групп и подгрупп для колонки «Информационная единица», определяющей специальную информацию. 5.2 Профиль документации Форма профиля документации (рис.2) представлена в качестве образца для создания профиля документации для системы программного обеспечения. В профиле документации таблица делится на несколько колонок. Каждый документ, требуемый для системы программного обеспечения, представлен колонкой (например, A, B, C). Смотрите Приложение А в качестве примера как нужно идентифицировать документы, изображенные на рис.2. После завершения профиль документации может использоваться для разработки плана документирования и для того, чтобы проверить, что система программного обеспечения документирована с достаточной степенью детализации. 5.3 Описание информационных единиц Информация для подготовки документов берется из информационных единиц. Информационная единица может содержать некоторое количество подпунктов в зависимости от степени детализации, требуемой для ее описания. Подпункты перечисляются в иерархическом порядке, основа для соглашения по нумерации используется для информационных единиц. Соглашение по нумерации: - каждый заголовок имеет номер для определения своей позиции в иерархии;
- каждая информационная единица имеет номер пункта, содержащий до четырех цифр;
- каждый подпункт имеет номер пункта, содержащий номер информационной единицы и дальнейший номер, отделенный точкой.
Информационные единицы сгруппированы и обозначены заголовками. Заголовок включает в себя номер, соответствующий месту в структуре. За номером следует название группы (может содержать краткое описание – см. рис.4). После заголовков, за каждой информационной единицей следует свой номер пункта. Номер пункта обеспечивает классификацию для пункта и его позицию в иерархии. Информационные единицы могут быть в двух формах: 1. Одиночная информационная единица содержит свой номер, название и содержание (см. рис.4). Одиночная информационная единица может, как присутствовать, так и отсутствовать в документе, но не может находиться на переменных уровнях детализации. 2. Составная информационная единица состоит из нескольких подпунктов, каждый из которых содержит свой номер, название и содержание. Составная информационная единица может находиться на переменных уровнях детализации в документе. Степень детализации в составной информационной единице выражена объединением подпунктов, соответствующих требуемому уровню (см. рис.4, 5 и 6). В настоящем стандарте составная информационная единица состоит из двух или трех степеней детализации (см. рис. 4). Заштрихованные колонки в рис. 4, 5 и 6 указывают на отсутствие дальнейших уровней детализации. В этом случае, требуемые детали должны быть представлены на уровне 1 или 2. Колонки (уровень 1, 2 или 3) указывают степени детализации. В случае составной информационной единицы, уровень 2 включает в себя все подпункты из уровня 1 плюс несколько дополнительных подпунктов. Также уровень 3 включает в себя все подпункты из уровня 2 плюс все оставшиеся подпункты для составной информационной единицы. Это означает (см. рис. 4, 5 и 6): - информационные единицы 1 уровня содержат все подпункты, указанные в колонке «уровень 1» информационной единицы;
- информационные единицы 2 уровня содержат все подпункты, указанные в колонке «уровень 2» информационной единицы;
- информационные единицы 3 уровня содержат все подпункты, указанные в колонке «уровень 3» информационной единицы.
Со временем в последующих документах, составная информационная единица может встречаться в увеличении детализации путем включения дополнительных подпунктов информации по этому вопросу. Это постепенное изменение степени детализации может повлечь за собой пересмотр документов, разработанных ранее в жизненном цикле программ. Поэтому необязательно, чтобы сами подпункты оставались идентичными по содержанию в течение жизненного цикла. В ходе работы над проектом может потребоваться корректировка информации для более точного отражения системы программного обеспечения. Если название подпункта встречается параллельно в двух или нескольких уровнях, значение подпункта может быть одинаковым на всех уровнях или может быть увеличено на уровне 2 и 3 по необходимости. Документ может содержать информационные единицы на различных уровнях детализации в зависимости от требований, указанных в профиле документации. Структура | Информационная единица | 1. Требование системы | 11 Определение проблемы | 12 Цели | 13 Обоснование для предложения | 14 Ссылки документа | 2. Описание системы | 21. Идентификация системы | 15 Ограничения | 16 Язык | 17 Договорная информация | 211 Название системы | | 22. Подробные требования | 212 Цели системы | 221 Функциональные требования | 222 Сведения | 223 Характеристика готовности | 23. Системные компоненты | 231 Организация системы | 224 Сокращения | 225 Терминология | 226 Информационная модель | 2311 Структура | | 232 Компоненты программного обеспечения | 2312 Интерфейсы | 2321 Организация программного обеспечения | 233 Физические компоненты | 2322 Получение данных | 2331 Блок обработки данных | 24. Тестирование | 2332 Периферийное оборудование данных | 2333 Технологическое периферийное оборудование | 2334 Другое оборудование | 2335 Оборудование | 2336 Помещение/инвентарь | 241 Цель испытаний | 25. Инсталляция | 242 Методы и средства испытаний | 243 Контрольный пример/аттестация | 251 Инсталляция/использование | 26. Человеческие ресурсы | 252 Обучение | 261 Персонал | 3. Индикаторы оценки | 262 Организация | 31 Расходы/Доходы | | 32 Опыт инсталляции | 33 Достоинства/Недостатки | 34 Критерии/методы оценки | 35 Результаты оценки | 4. Выводы/Рекомендации | 41 Решение | | 42 Обоснование | 43 Ответственность | Рисунок 1 – Обзор описания информационных единиц Рисунок 2 – Профиль документации Рисунок 3 – Иллюстрация описания информационных единиц Рисунок 4 – Иллюстрация 1-го уровня информационной единицы Рисунок 5 – Иллюстрация 2-го уровня информационной единицы Рисунок 6 – Иллюстрация 3-го уровня информационной единицы 5.4 Детальное описание информационных единиц. № | Информационная единица | Содержание информационной единицы | Уровень 1 | Уровень 2 | Уровень 3 | 1.Требования системы | 11 | Определение проблемы | | | Формулировка и определение проблемы решаются при развитии программного обеспечения | 12 | Цели | | | Утверждение ожидаемых результатов от программного обеспечения и требований программного обеспечения | 13 | Обоснование для предложения | | | Повод и обоснование для предложения | 14 | Ссылки | | | Перечень документальных ссылок для следующей фазы развития, напр. документация текущего состояния | 15 | Ограничения | | | Утверждение требований (условия, ограничения, планирование качества, безопасность) по разработке, предъявленных покупателем для следующей фазы, напр.: - метод реализации
- отчетный период
- дата завершения
| 16 | Язык | | | Должны быть определены языки, используемые для документов, напр., японский, французский, английский | 17 | Договорная информация | | | Должна быть указана договорная информация. Также должны быть указаны условия авторского права, лицензирования, условия использования или гарантии. Должен быть назван поручитель | | 2 Описание системы | 21 Идентификация систем | 211 | Название системы | | | Название, определяющее систему и (по возможности) номер единицы или код продукта | 212 | Цели системы Параметры системы: - Внешние эффекты системы
- Требования по характеристике системы в создании комплектующих узлов, напр. критерий оценки
| 212.1 | Требуемое название | Требуемое название | Требуемое название | Название, определяющее цель системы | 212.2 | Требуемое содержание | Требуемое содержание | Требуемое содержание | Описание целей системы и цель применения | 212.3 | | Требуемая иерархия | Требуемая иерархия | Представление целей систем высшего или низшего уровней (частичные, индивидуальные цели; основные ли соответствующие цели) | 212.4 | Область использования | Область использования | Область использования индивидуальных требований системы | 212.5 | Противоречивые требования | Противоречивые требования | Противоречивые требования, где выполнение одного требования препятствует выполнению другого | 212.6 | Дата завершения | Дата завершения | Момент времени, при котором определенное требование было выполнено или должно быть выполнено | 212.7 | Степень завершения | Степень завершения | Определение степени, при которой было или должно быть выполнено особое требование | 212.8 | | Индикатор характеристики | Определение индикаторов, которые должны использоваться для оценки выполнения требования | 212.9 | Нагрузка | Методы для определения приоритетов требований и для утверждения объективных приоритетов | | 22 Детальные требования Описание физической/логической системы осуществляется при разработке программного обеспечения | 221 | Функциональные требования Функциональные требования включают все логические функции, обеспечиваемые системой, независимо от их технической реализации | 221.1 | Имя задачи | Имя задачи | Имя задачи | Краткое, прикладное описание решаемых задач | 221.2 | | Иерархия задачи | Иерархия задачи | Иерархическая структура задач, подзадач | 221.3 | | Описание задачи | Задача должна быть описана в доступной общепринятой форме. Следует описать правила обработки и их логическую и временную зависимость | 221.4 | Методы | Методы | Краткое описание теорий и методов расчета, используемых для решения задач | 221.5 | | Теоретические принципы | Укажите теоретические принципы для решения проблем. Описать существенные шаги используемых методов | 221.6 | | Единицы измерения | Укажите используемые единицы измерения | 221.7 | Ограничения задачи | Ограничения задачи | Ограничения в сфере применения программного обеспечения, главным образом, целенаправленные требования и ограничения | 221.8 | | Граничное условие | Укажите технические, вычислительные или законодательные границы применения | 221.9 | | Время обработки | Укажите максимальное время, отведенное для обработки задачи | 221.10 | Ссылка на законы и положения | Ссылка на законы и положения | Ссылка на законы и положения | Укажите ссылки на законы, стандарты, руководящие принципы, указы, положения, ограничения, которые являются частью функциональных требований | 221.11 | | | Законы и положения | Укажите и, по необходимости, объясните важные детали законов, стандартов, указов, положений, имеющих отношение к программному обеспечению, включая источники. Укажите отклонения | 222 | Информация. Укажите все сведения, требуемые системой. | 222.1 | Наименование данных | Наименование данных | Наименование данных | Укажите наименование данных, ориентированное на конкретное применение, обозначив как входные, так и выходные данные | 222.2 | Содержание данных | Содержание данных | Содержание данных | Укажите подлинное содержание данных, по необходимости, называя группы данных с ссылкой на требования по защите данных | 222.3 | | Иерархия данных | Иерархия данных | Покажите структуру данных, напр. иерархию | 222.4 | Источник данных/ адресат | Источник данных/ адресат | Укажите источники данных. Адресаты данных; по необходимости обратитесь к группам данных и индивидуальным данным | 222.5 | Название группы данных | Название группы данных | Укажите названия групп данных, ориентированные на конкретное применение | 222.6 | Содержание группы данных | Содержание группы данных | Укажите подлинное содержание групп данных, по необходимости, указывая элементы данных с ссылкой на требования по защите данных | 222.7 | Использование группы данных | Использование группы данных | Укажите использование групп данных по отношению к проблемам, напр. Таблица по использованию данных. | 222.8 | | Взаимосвязь данных | Укажите связь между группами данных, элементами и задачами данных, напр. Матрица впуска/выпуска, таблица решений | 222.9 | Название элемента данных | Укажите название элементов индивидуальных данных, ориентированное на конкретное применение | 222.10 | Содержание элемента данных | Укажите подлинное содержание, значение элементов индивидуальных данных, напр., константа с ссылкой на требования по защите информации | 222.11 | Использование элемента данных | Укажите, как используется элемент данных в решении проблемы, напр., параметры, константы | 222.12 | Объем данных | Объем данных | Объем данных | Укажите объем данных для обработки | 222.13 | | | Ввод данных Частоты | Укажите плотность распределения, и распределение во времени ввода данных, с количеством данных | 222.14 | Увеличение данных | Укажите ожидаемое увеличение в объеме данных в выделенном интервале времени | 223 | Характеристика эксплуатационной готовности Характеристика готовности является, в основном, численной величиной, указывающей готовность системы, напр. плотность распределения, распределение во времени | 223.1 | Готовность системы | Готовность системы | | Укажите время или периоды времени (напр., время дня), когда система должна быть готова для использования | 223.2 | | Время реакции | Укажите максимальное время, заданное для системы для достижения результатов | 223.3 | Планирование по сроку завершения | Укажите интервал времени, когда результаты системы будут готовы | 224 | Ограничения Ограничения включают в себя безопасность, конфиденциальность, сохранность, используемость | 224.1 | Физические ограничения | | | Требования по формулировке решения, основанные на организации и производстве, доступными в целевой среде | 224.2 | Технические ограничения | Требования, основанные на информационных технологиях | 225 | Терминология | 225.1 | Термины | | | Список прилагаемой специфической информации и определений, используемых в документах | 225.2 | Описатель | Ключевые слова, характеризующие описываемую систему и ее уникальные свойства, которые могут использоваться в качестве поисковых терминов | 226 | Информационная модель | 226.1 | Методы | Методы | | Краткое описание теорий и методов информационного моделирования, используемых для решения информационных требований системы | 226.2 | | Теоретическое обоснование | | Укажите теоретическое обоснование для информационного моделирования. Опишите объекты данных, указывая условные обозначения и взаимосвязь данных | 226.3 | База данных/ Словарь данных | Опишите организацию функциональной структуры объектов данных для системы управления базой данных/словарем данных | | 23 Элементы системы. Описание элементов системы, выполняя требования, как запланировано или в соответствии с существующим программным обеспечением | 231 Организация системы | 2311 | Структура | Структура | | Укажите общую структуру системы | 2312 | Интерфейсы | Интерфейсы | Опишите интерфейсы по отношению к другим системам и между элементами систем | | 232 Элементы программного обеспечения | 2321 | Организация программного обеспечения | 2321.1 | Название программного обеспечения | Название программного обеспечения | Название программного обеспечения | Название для идентификации программного обеспечения, используемого в течение разработки, распространения и использования. Если программное обеспечение является частью системы программного обеспечения, также должно быть указано название системы | 2321.2 | | Альтернативное имя | Альтернативное имя | Названия некоторых программ могут отличаться (при использовании в одно и то же время), напр., в связи с различием настроек или при различном применении | 2321.3 | Версия | Версия | Версия | В дополнение к названию программы, следует находить отличия между некоторыми версиями/вариантами программы или ее альтернативами. Документы должны описывать состояние достоверных версий/вариантов | 2321.4 | Выпуск | Выпуск | Выпуск | Название выпуска первой и ныне достоверной версии/варианта. | 2321.5 | Дата выпуска | Дата выпуска | Дата выпуска | Дата выпуска первой и ныне достоверной версии/варианта | 2321.6 | | Вызов имени | Вызов имени | Утверждение имени вызова программы, используемого в языке программирования, языке проектирования (псевдокод) или в свободной форме | 2321.7 | | Требования по вызову | Условия для правильного вызова программы, напр., комбинации, события или триггеры разрешенного параметра | 2321.8 | Имя ввода | Имя ввода | Имя ввода | Укажите имя ввода, ориентированное на применение. Различия проводятся между вводом данных, уже сохраненных и обрабатываемых как база данных, и данных, нуждающихся в обработке | 2321.9 | | Цель ввода | Цель ввода | Описание целей ввода | 2321.10 | | | Детали ввода | В дополнение к предложению по организации описания данных, следует описать или назвать требуемые алгоритм и правила доступа. Это также требуется для команд, управляющих команд и функций. Следует указать, какие начальные значения введены программой для статистических данных. Для форматированных входных данных должна быть указана последовательность данных. Также следует привести примеры. Для неформатированных входных данных должны быть указаны условные обозначения этих данных, такие как: - разделители и их функции,
- ключевые слова для идентификации данных,
- нулевое значение
| 2321.11 | Имя выхода | Имя выхода | Имя выхода | Укажите имя выхода, ориентированное на конкретное применение. Различия между данными, сохраняемыми для дальнейшей обработки и данными, используемыми вне системы программного обеспечения, напр. таблицы, экраны, графические устройства, команды управления для управления техническими процессами | 2321.12 | | Цель выхода | Цель выхода | Описание целей выхода | 2321.13 | | Детали выхода | В дополнение к утверждениям по организации, данные, предназначенные для использования вне систем программного обеспечения, должны быть описаны примерами вывода (напр. вывод данных) с соответствующей интерпретационной поддержкой, или правилами, описывающими их формирование | 2321.14 | | | Передаваемая информация | Описание информации, передаваемой без изменений | 2321.15 | Функция программы | Функция программы | Функция программы | Краткое описание функций программы и интерфейсов пользователя | 2321.16 | | Описание информационного потока | Описание информационного потока | Информационный поток должен быть представлен на различных уровнях, напр. схемами информационных потоков. Все данные ввода-вывода и все передаваемые данные (информация) между программными модулями должны быть записаны в отношении значения, временной последовательности, носителя информации и устройств ввода-вывода | 2321.17 | | Последовательность выполнения программы | Последовательность выполнения программы | Последовательность внутреннего исполнения должна быть описана на различных уровнях; необходимо представить программные модули, подпрограммы, условные переходы, петли и секторы синхронизации. Описательные методы: - блок-схемы,
- таблицы решений,
- структурные схемы.
Описательные методы могут быть объединены, если это необходимо для описания программы. Описание должно содержать прямое и обратное продвижение потока программного обеспечения; также требуются перекрестные ссылки для источника программы и класса функций | 2321.18 | | | Алгоритмы | Описание метода решения и алгоритмов, представленное в связи с постановкой задачи и с конструкцией программного обеспечения. Назовите методы, используемые в конструкции программного обеспечения | 2321.19 | | | Ключ к используемым кодам | Описание используемых форматов и значений кодов. Укажите систему конструкции и допустимой оценки | 2321.20 2321.21 | | | Обработка ошибок | Предоставьте тест по проверке на наличие ошибок и укажите существующие сообщения по ошибке и конечные действия | | | Режим работы | Покажите режим работы (групповая операция, работа в реальном времени) | 2321.22 | | Структура программного обеспечения | Структура программного обеспечения | Структурирование программного обеспечения в элементах программного обеспечения (программы, подпрограммы, модули, процессы, общие модули/процессы) относительно решения проблемы. Структурирование может быть представлено как в графическом, так и в текстовом виде | 2321.23 | Блоки программного обеспечения | Блоки программного обеспечения | Список должен содержать названия, точки входа и интерфейсы блоков программного обеспечения, и их взаимосвязь | 2321.24 | Операционная система | Операционная система | Операционная система | Укажите изготовителя, название, выпуск и версию операционных систем, которые может выполнить программное обеспечение без модификации | 2321.25 | Другое программное обеспечение | Другое программное обеспечение | Другое программное обеспечение | Укажите изготовителя, название, выпуск и версию всех других требуемых программ, напр. вспомогательные, коммуникационные программы или другие программные продукты, требуемые для использования программ | 2321.26 | | | Язык программирования | Точно выраженное название используемых языков программирования, включая изготовителя, выпуск и версию | 2321.27 | Инструментальные средства разработки/ исполнения | Укажите требуемые средства (компиляторы, ассемблеры или интерпретаторы), включая изготовителя, выпуск и версию | 2321.28 | Исходный код | Последовательность инструкций и деклараций (напр. начальные значения и константы) или правила в исходном языке, включая комментарии. Исходный код также может быть частью листинга, выданного компилятором, ассемблером или интерпретатором | 2321.29 | | | Транслятор, канал связи | Документация, показывающая перевод из исходного кода в форму загрузки и рабочего цикла. Необходимо предоставить следующее: - перечень компилированного, собранного или интерпретированного программного обеспечения, включая ошибочные документы,
- перечень символических адресов и распределения памяти,
- перечень обратного продвижения адресных ссылок,
- перечень адресных ссылок для загрузки | 2321.30 | | Размер программного обеспечения | Размер программного обеспечения | Полный размер программного обеспечения в используемых единицах, напр. байты, линии исходного кода. Если необходимо, установите размер | 2321.31 | Расходы | Расходы | Расходы | Укажите расходы на приобретаемое оборудование, напр. покупная/ арендуемая цена, и операционные расходы (расходы по текущему обслуживанию) программного обеспечения | 2322 | Организация данных | 2322.1 | Имя файла | Имя файла | Имя файла | Утверждение названий для идентификации файла, в особенности: - название, ориентированное на конкретное применение,
- название, под которым операционная система соединяет программу с файлами,
- название базы данных, в которой хранится информация (по необходимости)
| 2322.2 | Содержание файла | Содержание файла | Содержание файла | Краткое описание содержания и целей | 2322.3 | | Индекс файла | Индекс файла | Индекс данных или группы данных файлов, различающихся по структуре или значению | 2322.4 | | Взаимосвязь | Взаимосвязь | Представление взаимосвязи данных или групп данных с файлами, в особенности структурой, последовательность данных/групп данных, сортирующая последовательность так же как возможная ключевая информация для доступа | 2322.5 | Использование файла | Использование файла | Использование файла | Укажите использование файлов, таких как: - файл транзакций,
- печатный файл
| 2322.6 | | Организация файла | Организация файла | Организация используемых данных, таких как: - последовательные,
- произвольные,
- ассоциативные,
- относительные.
Если для сохранения используется стандартизированный (нормативный) метод, он должен быть указан. Любой нестандартный метод должен быть описан | 2322.7 | | Структура файла | Если файл имеет структуру, это должно быть описано; Если структура отсутствует, это следует указать | 2322.8 | Носитель данных | Носитель данных | Укажите детали вида носителя записи для файла | 2322.9 | | Метка файла | Описание или название используемых меток (напр. для магнитных лент, жестких дисков, CD-ROM) для каждого носителя данных | 2322.10 | | | Запоминающий метод | Для каждого носителя должен быть указан запоминающий метод, такой как: - блокированный/разблокированный,
- сжатый/развернутый
| 2322.11 | | | Потребности в памяти | Потребности в памяти файла на носителе должны быть указаны в стандартных единицах (напр. в байтах, словах) как в абсолютной форме, так и форме алгоритмов | 2322.12 | | | Код | Укажите используемый код для представления знаков (символов) | 2322.13 | | Ссылочный тип | Ссылочный тип | Для каждого файла должны быть указаны используемые методы доступа (выборки) | 2322.14 | | Правила доступа | Правила доступа | Описание/название показателей или методов, которые определяют доступ лицами или программой | 2322.15 | | Защита | Защита | Укажите физические условия или условия, зависящие от времени, для защиты файла | 2322.16 | | | Период сохранности/Срок годности | Укажите период сохранности или срок годности. Если необходимо, укажите периоды дополнительного времени или моменты во времени, при которых доступ ограничен | 2322.17 | | | Методы безопасности | Описание или название методов, используемых для безопасности | 2322.18 | Реорганизация | Реорганизация | Утверждение условий (зависящих от времени или связанных с применением) для реорганизации и название или описание используемого метода | 2322.19 | Управление данными | Управление данными | Название, изготовитель и версия системы управления данными | 2322.20 | | | Организация технического обслуживания | Адрес организации или имя контактного лица, ответственного за подлинное содержание файла | 2322.21 | Название группы данных | Название группы данных | Название группы данных | Название группы данных, в особенности: - название, ориентированное на прикладную систему,
- название, используемое для указания записи в файлах
| 2322.22 | Содержание группы данных | Содержание группы данных | Содержание группы данных | Краткое описание содержания и целей | 2322.23 | Структура группы данных | Структура группы данных | Структура группы данных | Представление структуры данных с перечислением объектов данных, указывая их названия, и их местонахождение в группе данных. Следует указать разграничители длины и последовательности для различных групп данных. Если объекты данных сжаты для запоминания, следует описать или назвать метод | 2322.24 | | Формат группы данных | Формат группы данных | Укажите, какую длину имеет группа данных: постоянную или переменную. Другие форматы должны быть описаны | 2322.25 | | | Длина группы данных | Укажите длину группы данных в стандартных единицах (в байтах или словах). Для переменной длины укажите, по крайней мере, максимально допустимую длину | 2322.26 | | | Код группы данных | Укажите код, используемый для представления символов | 2322.27 | | Правила доступа | Правила доступа | Описание или название метода доступа субъектом или программой | 2322.28 | Название объекта данных | Название объекта данных | Название объекта данных | Укажите названия, используемые для определения объектов данных или элементов данных, в особенности: - название, ориентированное на прикладную систему,
- название, используемое для группы данных
| 2322.29 | Содержание объекта данных | Содержание объекта данных | Содержание объекта данных | Краткое описание содержания, направленное на прикладную систему | 2322.30 | Тип объекта данных | Тип объекта данных | Тип объекта данных | Укажите тип объекта данных, отвечающего за содержание объекта, напр. код, текст, указатель, вектор, время, таблица. | 2322.31 | | Длина объекта данных | Длина объекта данных | Укажите длину объекта данных в стандартных единицах; для переменной длины укажите, по крайней мере, максимально допустимую длину | 2322.32 | | | Код объекта данных | Укажите код, используемый для представления знаков | 2322.33 | | Область значений | Область значений | Укажите область значений, действительную для объекта данных | 2322.34 | | | Формат данных | Опишите формат данных, в котором хранится объект данных. Также укажите заполняющий символ, используемый в объекте данных или в представлении символа объекта отсутствия данных. Спецификация формата языка программирования не достаточна | 2322.35 | | | Набор символов | Укажите символы, действительные в пространстве | 2322.36 | Внешнее представление | Укажите, каким образом должно быть отформатировано поле данных для внешнего представления, напр. печатная рамка (изображения) | 2322.37 | Кодирование/Декодирование | Кодирование/Декодирование | Если для представления данных используются коды, это должно быть описано в значении, связанном с условиями эксплуатации/пользователем. Следует указать правила кодирования или дать ссылку на перечень кодов | 2322.38 | Правила доступа | Правила доступа | Описание или название метода доступа субъектом или программой | 2322.39 | Расходы | Расходы | Укажите расходы по организации прохождения данных | | 233 Физический элемент Физическими источниками являются оборудование, материалы и помещение, требуемые для работы системы | 2331 | Процессоры (устройства обработки данных) Процессорами являются устройства, выполняющие первичную обработку, включая вычислительные машины, серверы, персональные компьютеры | 2331.1 | Название | Название | Название | Укажите торговую марку (изготовитель/ тип) | 2331.2 | | Размеры | Размеры | Укажите размер и количество процессоров | 2331.3 | | | Описание | Точное описание процессоров (модель, память, выпуск/версия, возможность подключения к другому оборудованию) и дополнительное оборудование | 2331.4 | | | Конфигурация | Покажите взаимосвязь процессоров и другого оборудования, если возможно, в графической форме, напр. диаграмма конфигурации | 2331.5 | Расходы | Расходы | Расходы | Укажите стоимость приобретаемого оборудования, напр. покупная/арендуемая цена, и эксплуатационные расходы (расходы по текущему обслуживанию) процессоров | 2332 | Периферийное оборудование данных | 2332.1 | Название | Название | Название | Укажите тип и торговую марку | 2332.2 | | Рабочая характеристика | Рабочая характеристика | Укажите типичные технические характеристики и количество единиц оборудования | 2332.3 | | | Описание | Точное описание периферийного оборудования, включая: - метод записи,
- плотность (расположения) знаков,
- набор знаков,
- код,
- длина линии или блока,
- объем памяти,
- процесс передачи,
- скорость передачи
| 2332.4 | | Передача данных | Передача данных | Описание используемой сети передачи данных, если возможно, в графической форме | 2332.5 | Расходы | Расходы | Расходы | Укажите стоимость приобретаемого оборудования, напр. покупная/арендуемая цена, и эксплуатационные расходы (текущее обслуживание) | 2333 | Технологическое периферийное оборудование | 2333.1 | Название | Название | Название | Укажите тип (аналоговый ввод/вывод, цифровой ввод/вывод, сеть) и торговую марку | 2333.2 | | Рабочие характеристики | Рабочие характеристики | Укажите типичные технические характеристики и количество оборудования | 2333.3 | | Описание | Точное описание оборудования, включая: - цикл памяти,
- точность,
- время преобразования,
- соединение нескольких функциональных единиц,
- зависимость передачи,
- характеристики, согласно типу соединения,
- расстояние
| 2333.4 | Подключение процессора | Подключение процессоров, их связи (главные или дополнительные, звезда, цепь, сетевое подключение) и технические подробности межсоединений, напр. передача данных или общая память | 2333.5 | Расходы | расходы | Расходы | Укажите затраты на приобретение и функционирование процессора | 2334 | Другое оборудование Другое необходимое оборудование, включая: - копировальные устройства,
- микрофильм, оборудование СОМ,
- бухгалтерские машины, калькуляторы, текстовые процессоры,
- устройства ввода данных,
- разделители, упаковочные машины,
- кондиционирование воздуха, аварийное электроснабжение, аварийная сигнализация
| 2334.1 | Название | Название | Название | Укажите тип и торговую марку. | 2334.2 | | Характеристики | Характеристики | Укажите типичные технические характеристики и количество единиц оборудования | 2334.3 | | | Описание | Точное описание оборудования, с ссылками на документы производителя, если возможно | 2334.4 | | Применение | Применение | Объяснение по использованию оборудования в процессе, если возможно, в графической форме | 2334.5 | Расходы | Расходы | Расходы | Укажите стоимость на приобретение и функционирование оборудования | 2335 | Оборудование Включает: - бумагу, формы, офисное оборудование,
- микрофильмирующее оборудование,
- магнитные носители, немагнитные носители,
- электроэнергия, вода
| 2335.1 | Название | Название | | Укажите тип и название материала (торговую марку, шифр компонента, количество бланков) | 2335.2 | | Характеристика | Технические свойства, характерные для индивидуальных материалов | 2335.3 | Использование | Укажите, где и как будет использоваться материал | 2335.4 | Количество | Количество | Объем требуемого материала | 2335.5 | Расходы | Расходы | Укажите стоимость материала | 2336 | Помещение/Инвентарь Описание физической среды | 2336.1 | Название | Название | | Название, местоположение и описание капитального оборудования | 2336.2 | | Характеристика | | Укажите технические характеристики, такие как временная нагрузка на перекрытие, кондиционирование воздуха | 2336.3 | | Использование | | Назначение капитального оборудования | 2336.4 | Размер, Количество | Размер, Количество | | Укажите размер и количество капитального оборудования или инвентаря | 2336.5 | Расходы | Расходы | | Укажите расходы на приобретение и техническое обеспечение оборудования | | 24 Тестирование Описание требований, процедур и результатов тестов, основанное на целях и планах системы | 241 | Цели испытаний | 241.1 | Наименование цели | Наименование цели | | Наименование цели, напр. проверка ошибок, приемосдаточные испытания, испытание системы | 241.2 | | Содержание цели | | Описание определения цели испытания для идентифицирования объектов испытания (спецификация требований, программный модуль, общая система) и области испытания, напр. завершенность, время реакции (системы), соблюдение стандартов | 241.3 | | Ограничения испытаний | | Укажите ограничения испытаний, включая сокращения, последовательность предположений и выполнения. Опишите ограничения тестирования для каждого тестируемого программного процесса | 242 | Методы и средства тестирования | 242.1 | Название метода | Название метода | Название метода | Укажите название метода тестирования или существенные шаги используемого метода | 242.2 | | Описание метода | Описание метода | Точное описание используемого метода тестирования или ссылка на внешнее описание метода | 242.3 | | Среда тестирования | Среда тестирования | Точное описание испытательного стенда или области имитационного моделирования | 242.4 | Название средства | Название средства | Название средства | Укажите название средств тестирования или используемых моделей | 242.5 | | Описание средств | Описание средств | Описание используемых средств тестирования, контрольной структуры, структуры тестовых данных, программы моделирования тестов или ссылка на внешнее описание | 242.6 | | | Среда средств | Описание среды средств тестирования | 243 | Контрольные примеры/Контрольные задачи | 243.1 | Название | Название | Название | Название или описание контрольного примера, связанного с целью испытаний, тестирование соответствия решения целям и требованиям системы | 243.2 | | Входные данные теста Описание | Входные данные теста Описание | Утверждение входных данных в форме, допускающей подтверждение результатов, с искомым значением. Опишите входные данные теста, тестовые программы, создающие входные данные, ожидаемые результаты, и сообщения по ошибке | 234.3 | | Формат входных данных теста | Описание формата входных данных теста, область значений и фактор преобразования данных | 243.4 | Выходные данные теста Описание | Выходные данные теста Описание | Утверждение выходных данных в форме, допускающей подтверждение результатов, с искомым значением. Опишите выходные данные теста, тестовые программы, создающие выходные данные, ожидаемые результаты, и сообщения по ошибке | 243.5 | | | Формат выходных данных теста | Описание формата выходных данных теста, область значений и фактор преобразования данных | 243.6 | Результаты | Результаты тестов в проверяемой форме | | 25 Инсталляция Описание предпринимаемых шагов для инсталляции новой системы | 251 | Инсталляция/Использование | 251.1 | Способ установки | Способ установки | Способ установки | Объяснение метода, по которому инсталлируется новая система, напр. параллельная работа, ступенчатая инсталляция | 251.2 | | Инсталляция | Инсталляция | Шаги, требуемые для установки системы, включая: - объединение, монтаж, проход канала связи,
- начальная загрузка,
- настройка файлов,
- подготовка оборудования,
приобретение дополнительных материалов | 251.3 | | | Контроль в процессе инсталляции | Документальное доказательство, показывающее завершенность инсталляции, включая: - компилятор, ассемблер,
- листинг редакторов связей,
- документация по передаче данных,
- документация по инсталляции данных,
- доклад по эксплуатационной готовности дополнительных материалов
| 251.4 | Авторизация выпуска | Документ, подтверждающий выпуск системы для функционирования | 251.5 | Функционирование и эксплуатация | Технические инструкции для функционирования и эксплуатации системы | 251.6 | Использование | Инструкции по использованию системы | 252 | Обучение | 252.1 | Планирование обучения | Планирование обучения | | Информация, указывающая на знания, требуемые для инсталляции, работы и использования системы и указание последовательности процесса обучения | 252.2 | | Материалы по обучению | Материалы, требуемые для обучения, напр. справочник по обучению, учебное пособие, видео. Выдержки из документации системы, напр. руководство по функционированию, справочник пользователя | | 26 Трудовые ресурсы | 261 | Персонал | 261.1 | Группа деятельности | Группа деятельности | Группа деятельности | Название групповой концепции для деятельности или утверждение профессиональной классификации необходимого персонала, напр. технический персонал, эксперт, специалист по управлению | 261.2 | | Наименование деятельности | Наименование деятельности | Название деятельности необходимого персонала или профессиональной должности, напр. руководитель проекта, специалист по программному обеспечению | 261.3 | | Деятельность | Описание деятельности персонала | 261.4 | | | Квалификация | Утверждение знаний и возможностей, требуемых от персонала | 261.5 | Номер | Номер | Номер | Количество необходимого персонала | 261.6 | Расходы | Расходы | Расходы | Укажите кадровые расходы | 262 | Организация Организационными единицами являются как позиции (пользователи, разработчики, поставщики), предназначенные для определения задач внутри системы, так и позиции, требуемые для предоставления данных системе, или дающие право на получение результатов системы | 262.1 | Роль | Роль | Роль | Роль для определения должности по имени или адресу | 262.2 | Функциональная область действия | Функциональная область действия | Функциональная область действия | Наименования функций, которые должны быть представлены должностью, включая службу работы с покупателями | 262.3 | | | Описание позиции | Описание функций, представляемых должностью и их обязанностями | 262.4 | Структура | Структура | Указание размещения должности в общей организационной структуре, напр. организационная таблица | 262.5 | | Группа деятельности Назначение | Группа деятельности Назначение | Группа деятельности, назначенная к должности | 262.6 | | Кадровое назначение | Назначение сотрудников на должность, номер и наименование деятельности | 262.7 | Назначение ресурсов | Назначение ресурсов | Физические и финансовые ресурсы, напр. пункт сбора и обработки данных (тип, количество), бюджет | | 3 Оценочные индикаторы Оценочные документы содержат основные элементы данных для оценки системы | 31 | Расходы/Прибыль | 31.1 | Составление сметы | Составление сметы | Составление сметы | Утверждение ориентировочной стоимости для разработки / приобретения системы и функционирования | 31.2 | | Калькуляция затрат | Калькуляция затрат | Утверждение фактической стоимости для разработки / приобретения системы и функционирования | 31.3 | | Расходы на приобретение | Утверждение расходов на разработку / приобретение системы | 31.4 | | | Текущие расходы | Утверждение текущих расходов системы | 31.5 | Расчет выгоды | Расчет выгоды | Расчет выгоды | Общее утверждение ожидаемой прибыли системы | 31.6 | | Ощутимая выгода | Ощутимая выгода | Утверждение прибыли, ее единицы измерения и превращение в денежную стоимость | 31.7 | Неощутимая выгода | Неощутимая выгода | Утверждение прибыли, которая не может быть выражена в денежной стоимости | 32 | Опыт инсталляции | | | Опыт, приобретенный в течение инсталляции системы, напр. соответствие планам, особые затруднения и их устранение, качество учебных материалов | 33 | Преимущества/Недостатки | 33.1 | Название | Название | | Утверждение преимуществ и недостатков системы, напр. в сравнении с альтернативными системами, учитывая цели и требования | 33.2 | | Вид | Утверждение преимуществ и недостатков системы, таких как, выполнение целей задачи, степень выполнения целей, потребление ресурсов | 33.3 | Степень | Утверждение порядка величины или вес преимуществ и недостатков, напр., время реакции на 30% быстрее установленного | 33.4 | | Эффекты | | Утверждение немедленных эффектов, вызванных различными преимуществами и недостатками | 33.5 | | Побочные эффекты | | Описание неожиданных, внеплановых эффектов системы, если они могут быть включены в оценку общей системы | 34 | Критерии/Методы Оценки | 34.1 | Название критериев | Название критериев | | Названия критериев, используемых для оценки системы | 34.2 | | Описание критериев | | Описание критериев и их веса по отношению к оценке общей системы | 34.3 | Название метода | Название метода | | Название методов, используемых для оценки, оценки процесса и продукции; включая метрику программного обеспечения | 34.4 | | Описание метода | | Описание методов, используемых для оценки. Ссылка на существующее описание может быть достаточной | 35 | Результаты оценки | 35.1 | Результат | Результат | | Утверждение результата, основанного на всех обоснованных фактах. Любые сертификаты, присужденные системе | 35.2 | | Оценка | Сравнение отдельных фактов, включенных в оценку | | 4 Выводы/Рекомендации Выводы/рекомендации являются точкой зрения, принятой ответственным лицом, основанной на существующих результатах и образуют основу для дальнейшей деятельности в разработке программного обеспечения | 41 | Решение | | | Утверждение решения | 42 | Обоснование | | | Утверждение причин, ведущих к решению | 43 | Ответственность | | | Имя ответственного лица или производителя системы или торговой организации, напр., имя, адрес, должность или компания | Приложение А (информационное) Пример профиля документации Здесь приведен пример профиля документации для двух документов: Документ А: | Раздел 1 ГОСТ ИСО 9127 Документация пользователя для потребительских программных пакетов | Документ В: | Раздел 2 ГОСТ ИСО 9127 Информация на упаковке для потребительских программных пакетов | Документы А и В были выбраны потому что они являются ссылочными документами к настоящему стандарту и доступны всем читателям этого документа. Они содержат ссылки на основные (О), условные (У) и необязательные (Н) информационные единицы. Это показано в столбцах А и B. Пример Информационная единица | Документ | № | Название | Уровень | А | В | | | 1.Требования системы | | | | | 11 | Определение проблемы | 1 | | | | 12 | Цели | 1 | | | | 13 | Обоснование для предложения | 1 | | | | 14 | Ссылки | 1 | У | | | 15 | Ограничения | 1 | | Н | | 16 | Язык | 1 | Н | | | 17 | Договорная информация | 1 | О | У | | | 2 Описание системы | | | | | | 21 Идентификация систем | | | | | 211 | Название системы | 1 | О | О | | 212 | Цели системы | 1 | О | | | 2 | | | | 3 | У | | | | 22 Детальные требования | 221 | Функциональные требования | 1 | | О | | 2 | О | | | 3 | У | | | 222 | Информация | 1 | О | У | | 2 | | | | 3 | | | | 223 | Характеристика эксплуатационной готовности | 1 | | | | 2 | У | | | 224 | Ограничения | 1 | | У | | 225 | Терминология | 1 | У | | | 226 | Информационная модель | 1 | | | | 2 | | | | | 23 Элементы системы | | 231 Организация системы | 2311 | Структура | 1 | | | | 2 | | | | 2312 | Интерфейсы | 1 | | | | 2 | | | | | 232 Элементы программного обеспечения | 2321 | Организация программного обеспечения | 1 | | У | | 2 | | | | 3 | О | | | 2322 | Организация данных | 1 | | | | 2 | О | | | 3 | У | | | | 233 Физические элементы | 2331 | Процессоры | 1 | | О | | 2 | У | | | 3 | | | | 2332 | Периферийное оборудование данных | 1 | | О | | 2 | О | | | 3 | | | | 2333 | Технологическое периферийное оборудование | 1 | | О | | 2 | О | | | 3 | | | | 2334 | Другое оборудование | 1 | О | | | 2 | | | | 3 | | | | 2335 | Оборудование | 1 | О | | | 2 | | | | 2336 | Помещение/Инвентарь | 1 | | | | 2 | | | | | 24 Тестирование | 241 | Цели испытаний | 1 | | | | 2 | Н | | | 242 | Методы и средства тестирования | 1 | Н | | | 2 | | | | 243 | Контрольные примеры/Контрольные задачи | 1 | | | | 2 | Н | | | | 25 Инсталляция | 251 | Инсталляция/Использование | 1 | | | | 2 | | | | 3 | О | | | 252 | Обучение | 1 | | Н | | 2 | О | | | | 26 Трудовые ресурсы | 261 | Персонал | 1 | | | | 2 | | | | 3 | | | | 262 | Организация | 1 | О | О | | 2 | | | | 3 | | | | | 3 Оценочные индикаторы | 31 | Расходы/Прибыль | 1 | | | | 2 | | | | 3 | | | | 32 | Опыт инсталляции | 1 | Н | Н | | 33 | Преимущества / Недостатки | 1 | | | | 2 | | | | 34 | Критерии / Методы Оценки | 1 | | | | 2 | | | | 35 | Результаты оценки | 1 | | Н | | 2 | | | | | 4 Выводы / Рекомендации | 41 | Решение | 1 | | | | 42 | Обоснование | 1 | | | | 43 | Ответственность | 1 | О | О | | О = Основная У = Условная Н = Необязательная | Документ А = Документация пользователя для потребительских программных пакетов по ГОСТ ИСО 9127. Документ В = Информация на упаковке для потребительских программных пакетов по ГОСТ ИСО 9127.
|