Документация

Руководство пользователя Boroda

1. Начало работы

Обзор

Борода — система управления требованиями, разработанная для обеспечения соответствия DO-178C / КТ-178С при разработке авиационного программного обеспечения. Система предоставляет инструменты для управления требованиями, трассируемости, контроля изменений, документов жизненного цикла и сертификационных артефактов.

Главная страница

Главная страница представляет четыре ключевые возможности Борода: Редактор документов, Трассируемость требований, Соответствие DO-178C и Импорт/экспорт. Нажмите «Попробовать бесплатно» для регистрации или «Вход» для входа в систему.

Регистрация

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

Вход в систему

Введите адрес электронной почты и пароль для входа в систему. Используйте флажок «Запомнить меня» для сохранения сессии. Если вы забыли пароль, нажмите «Забыли пароль?» для сброса.

2. Навигация

Боковая панель

После входа рабочее пространство организовано вокруг боковой панели с разделами: Документы, Пространства, Спецификации, Изменения, Сертификация, Документы ЖЦ, Корзина и Настройки. Боковую панель можно свернуть до режима иконок. Используйте Ctrl+K для вызова глобального поиска из любого места.

3. Документы

Управление документами

Раздел «Документы» — это область общего управления документами. Создавайте документы, организуйте их в папки, фильтруйте по типу/статусу/сортировке, ищите по названию, переключайте вид между списком и сеткой. Каждый документ имеет статус (Черновик, Опубликован, Архивный), автора и дату изменения.

Редактор документов

Редактор документов основан на TipTap (ProseMirror) и поддерживает форматирование: заголовки, списки, таблицы, изображения, блоки кода и многое другое. Все изменения сохраняются автоматически с историей версий.

4. Пространства

Рабочие пространства

Пространства — это изолированные рабочие области для командной работы. Каждое пространство имеет свои документы, спецификации, требования, участников с ролями (Владелец, Администратор, Редактор, Наблюдатель), запросы на изменение, отчёты о проблемах и сертификационные артефакты.

5. Спецификации и требования

Список спецификаций

Спецификации — это контейнеры для требований. Каждая спецификация имеет уникальный код (например, SRS-001), тип (SRS, SDD, HLR, LLR, IRS, STP, STD, SVP) и версию.

Детали спецификации

При открытии спецификации отображаются: заголовок с кодом и статусом, карточки статистики с количеством требований, кнопки действий (Рецензии, Базовые линии, Матрица трассируемости, Анализ покрытия, Импорт, Экспорт) и список требований в режиме Дерево или Таблица.

Табличный вид

Табличный вид предоставляет табличный интерфейс с колонками: Код, Описание, Статус, DAL, Приоритет, Верификация, Безопасность, Производное, Связи и Комментарии. Добавляйте требования, нажав «+ Добавить требование...» внизу таблицы.

Детали требования

Каждое требование имеет: Код (автогенерируемый), Содержание (с форматированием), Статусный процесс (Черновик → На рецензии → Утверждено), Приоритет (MoSCoW), Уровень DAL (A-E), Флаг безопасности, Флаг производного, Метод верификации, Обоснование, Родитель и Трассировочные связи.

6. Трассируемость и покрытие

Матрица трассируемости

Матрица трассируемости показывает связи между требованиями различных спецификаций. Типы связей: SATISFIES (зелёный), DERIVES_FROM (синий), VERIFIED_BY (фиолетовый), IMPLEMENTS (индиго), REFINES (голубой), CONFLICTS (красный), DEPENDS_ON (жёлтый) и TRACES_TO (серый). Подозрительные связи автоматически помечаются при изменении связанных требований.

Анализ покрытия

Анализ покрытия показывает процент требований, покрытых верификационными мероприятиями. Это поддерживает Таблицу A-7 DO-178C, выявляя непокрытые требования, полностью покрытые требования и общий процент покрытия.

7. Базовые линии и рецензирование

Базовые линии

Базовые линии фиксируют состояние требований на определённый момент времени. Процесс: Черновик → Ожидание утверждения → Утверждена (или Отклонена). Утверждённые базовые линии неизменяемы. Вы можете сравнить любую базовую линию с текущей версией.

Рецензирование

Рецензии реализуют процесс рецензирования по DO-178C. Создайте рецензию, назначьте рецензентов, используйте контрольные списки DO-178C, отслеживайте замечания до устранения.

8. Импорт и экспорт

Обмен данными

Форматы экспорта: CSV, XLSX, ReqIF (с трассировочными связями), PDF (Список требований или Матрица трассируемости). Форматы импорта: CSV (с мастером маппинга колонок), ReqIF (с сохранением структуры и связей).

9. Управление изменениями (DO-178C)

Панель управления

Управление изменениями реализует процесс SCM по DO-178C. Панель показывает сводную статистику по запросам на изменение (ЗИ) и отчётам о проблемах (ОП).

Запросы на изменение

Запрос на изменение документирует предлагаемую модификацию. Процесс: Черновик → Подан → На рассмотрении → Утверждён → В работе → Проверен → Закрыт (или Отклонён). Поля: Код, Название, Тип, Приоритет, Статус, Инициатор.

Отчёты о проблемах

Отчёт о проблеме документирует дефект или аномалию. Процесс: Открыт → Подтверждён → Анализ → Исправление → Решён → Проверен → Закрыт (или Отложен). Уровни серьёзности по DO-178C: Катастрофический, Опасный, Существенный, Незначительный, Без эффекта.

10. Сертификация (DO-178C)

Панель сертификации

Модуль сертификации управляет артефактами, необходимыми для сертификации по DO-178C, предоставляя обзор конфигурационных единиц, библиотек, релизов и подписей.

Конфигурационные единицы

Конфигурационные единицы (КЕ) — артефакты под управлением конфигурацией. Атрибуты: Номер КЕ, Название, Тип, Версия, Статус и Категория контроля (CC1 для DAL A-C, CC2 для DAL D-E).

Релизы

Релизы отслеживают формальные сборки ПО, привязанные к базовым линиям требований. Процесс: Черновик → Ожидание авторизации → Авторизован → Выпущен → Архивирован. Каждый релиз связан с базовой линией.

Электронные подписи

Электронные подписи обеспечивают утверждения в соответствии с DO-178C. Каждая подпись содержит: тип, значение, подписываемый объект, временную метку и статус действительности.

11. Документы жизненного цикла (DO-178C)

Список документов

DO-178C требует документы жизненного цикла: PSAC, SDP, SVP, SCMP, SQAP, SReqS, SDS, SCS, SCI, SECI, SAS, HDD, SVD. Нажмите «Инициализировать шаблоны» для автоматического создания всех документов. Панель показывает количество документов, средства разработки и процент готовности к сертификации.

Детали документа

Каждый документ жизненного цикла содержит структурированные разделы на основе требований DO-178C. Редактируйте разделы непосредственно в редакторе. Каждый документ показывает прогресс-бар полноты.

Средства разработки (SECI)

Страница средств разработки реализует SECI по DO-178C. Все средства разработки и верификации должны быть идентифицированы, а те, чей выход является частью бортового ПО, должны быть квалифицированы. Атрибуты: Название, Версия, Поставщик, Назначение и Статус квалификации.

12. Настройки

Настройки

Настройки разделены на четыре секции: Профиль (имя, email, аватар, язык), Безопасность (изменение пароля), Уведомления (email-уведомления) и Оформление (настройка темы).

13. Руководство по процессу DO-178C

Фаза 1: Планирование

Создайте пространство для проекта. Инициализируйте документы ЖЦ (PSAC, SDP, SVP, SCMP, SQAP и др.). Зарегистрируйте средства разработки со статусом квалификации. Заполните планы содержанием проекта.

Фаза 2: Разработка требований

Создайте спецификации (SRS, HLR, LLR, IRS). Напишите требования с уровнем DAL, флагом безопасности, методом верификации и приоритетом. Установите трассировочные связи между спецификациями. Отметьте производные требования с обоснованием.

Фаза 3: Рецензирование требований

Переведите требования в статус «На рецензии». Создайте рецензию, назначьте рецензентов (минимум один независимый по DO-178C). Используйте контрольные списки. Устраните замечания и утвердите требования.

Фаза 4: Установление базовых линий

После утверждения требований создайте базовую линию с версией и названием этапа. Подайте на утверждение. Утверждённые базовые линии неизменяемы и служат официальной записью конфигурации.

Фаза 5: Контроль изменений

Создайте запросы на изменение для изменений после базовой линии. Проведите анализ воздействия. После утверждения ЗИ реализуйте изменения. Проверьте Матрицу трассируемости на подозрительные связи. Создайте отчёты о проблемах для дефектов.

Фаза 6: Верификация

Используйте Анализ покрытия для проверки верификационных связей. Экспортируйте Матрицу трассируемости в PDF для сертификационных доказательств. Экспортируйте требования в ReqIF для обмена с другими инструментами.

Фаза 7: Сертификация

Убедитесь, что все документы ЖЦ утверждены или выпущены. Создайте конфигурационные единицы для всех артефактов. Создайте релиз, привязанный к базовой линии. Подпишите релиз электронными подписями. Экспортируйте Итоговый отчёт по ПО (SAS). Проверьте процент готовности к сертификации.