Правила построения идентификаторов элементов документации
Идентификаторы всех элементов документации (требований, определений и т.п.) должны быть уникальными в рамках проекта. Общая структура идентификатора имеет вид: ID-nn, где ID – идентификатор типа, а nn – порядковый номер элемента соответствующего типа. При удалении какого-либо элемента перенумерация оставшихся элементов не производится, а в соответствующем списке элементов идентификатор данного элемента помечается как удаленный. Полное определение элемента дается только в исходном для него документе. В остальных документах делается только ссылка на элемент посредством указания его идентификатора. Подобные ограничения необходимы для обеспечения ссылочной целостности документации и исключения неоднозначных трактовок при изменениях описаний элементов.
Идентификаторы различных элементов документации:
Бизнес-требования | Имеют идентификатор типа BT (Business Requirement – Task) для бизнес-задач и BA (Business Requirement – Aims) для бизнес-целей |
Бизнес-правила | Имеют идентификатор типа BR (Business Rule) |
Предположения | Имеют идентификатор типа А (Assumption) |
Зависимости | Имеют идентификатор типа D (Dependence) |
Ограничения | Имеют идентификатор типа C (Constraint) |
Действующие лица | Имеют идентификатор типа ACT(Actor) |
Варианты использования | Имеют идентификатор типа UC (Use Case). Нормальный поток варианта использования идентифицируется как «X.0», где «X» – идентификатор варианта использования. Например, нормальный поток варианта использования UC-15 будет обозначаться как UC-15.0. Каждый альтернативный поток идентифицируется как «X.Y», где «X» – идентификатор варианта использования, а «Y» – порядковый номер альтернативного потока. Например, UC-15.3 указывает на третий альтернативный поток для варианта использования UC-15. Каждое исключение идентифицируется как «X.Y.E.Z», где «X» – идентификатор варианта использования, «Y» – нормальный поток (0) или альтернативный поток (>0), «E» признак исключения, а «Z» – порядковый номер исключения. Например, UC-15.0.E.2 определяет второе исключительное состояние для нормального потока варианта использования UC-15 |
Функциональные требования | Имеют идентификатор типа FR (Functional Requirement). Поскольку функциональные требования упорядочиваются по вариантам использования, для их идентификации используется схема вида FR-uc-xx, где uc – номер соответствующего варианта использования, а xx – порядковый номер функционального требования. Для всех функциональных требований, которые не связаны с конкретными вариантами использования, или являются общими для нескольких вариантов использования рекомендуется в качестве номера варианта использования указывать нулевое значение. |
Требования к интерфейсам пользователя | Имеют идентификатор типа IU (User Interfaces) |
Требования к интерфейсам оборудования | Имеют идентификатор типа IH (Hardware Interfaces) |
Требования к интерфейсам программного обеспечения | Имеют идентификатор типа IS (Software Interfaces) |
Требования к интерфейсам передачи информации | Имеют идентификатор типа IC (Communications Interfaces) |
Требования к производительности | Имеют идентификатор типаPR (Performance Requirements) |
Атрибуты качества | Имеют идентификатор типаQA (Quality Attribute) |
Дата добавления: 2021-11-16; просмотров: 294;