Работая над проектами связанными с авионикой мне потребовалось оформить несколько комплектов документации с полным описанием проекта. Также следовало учитывать требования многих ГОСТов на оформление и на содержание документации, таких как ЕСПД, КТ-178B и других.
Описание должно было в себя включать:
Объем документирования очень большой. Данные во всех документах связаны друг с другом, поэтому при изменении проекта (например добавления нового требования), приходится редактировать практически все документы. Плюс к этому можно где-то ошибиться или забыть поправить, что приводит к ошибкам в документации.
![](https://habrastorage.org/files/659/82a/cc4/65982acc4e7f40f0b1b29a37a59c86aa.jpg)
Далее в статье я расскажу как я решил эту проблему.
Описание должно было в себя включать:
- Планы разработки ПО
- Требования к ПО
- Описание реализации требований к ПО
- Таблицы трассируемости(соответствия) требований к ПО и реализации
- Описание тестов на ПО (Примеры и процедуры верификации ПО)
- Таблицы трассируемости(соответствия) требований к ПО и тестов
- Отчет об обнаруженных проблемах
- Указатель конфигурации(описание версии ПО и совместимости со сторонним ПО и оборудованием)
Объем документирования очень большой. Данные во всех документах связаны друг с другом, поэтому при изменении проекта (например добавления нового требования), приходится редактировать практически все документы. Плюс к этому можно где-то ошибиться или забыть поправить, что приводит к ошибкам в документации.
![](https://habrastorage.org/files/659/82a/cc4/65982acc4e7f40f0b1b29a37a59c86aa.jpg)
Далее в статье я расскажу как я решил эту проблему.