Куда я попал?
AppSec Table Top: методология безопасной разработки от Positive Technologies
Framework
Эксплуатационная документация
Для проведения оценки соответствия по документу войдите в систему.
Список требований
-
Инициатива: Эксплуатационная документация
Описание:
Развертываемое приложение должно сопровождаться комплексной документацией, которая обеспечивает четкое понимание его структуры, функциональности, используемых технологий и процесса эксплуатации. Такая документация может включать:- Архитектурную схему [TP4]: общее устройство приложения, взаимодействие компонент и подсистем, используемые технологии и инфраструктурные решения.
- Описание компонент и подсистем: подробное описание каждой компоненты или подсистемы приложения, их функциональность, взаимодействие с другими компонентами, используемые технологии и библиотеки.
- Диаграммы потоков данных: визуализация движения данных в приложении и между компонентами.
- Руководства по эксплуатации: процессы установки, настройки, запуска и остановки приложения, а также решения по устранению распространенных проблем и ошибок.
- Настройки конфигурации [PA1]: детальное описание всех конфигурационных параметров приложения
- Описание механизмов внедрения в эксплуатацию и обновления [PA2]: процесс развертывания приложения, а также механизмы обновления.
- Паспорт системы: краткое описание приложения, его функциональности, используемого технологического стека [TP1].
Такая документация позволяет лучше понимать приложение разработчикам, администраторам и другим заинтересованным лицам, упрощает процесс сопровождения, а также позволяет легче вносить изменения в приложение, обновлять его и проводить аудит безопасности [ISA2].
Шаги реализации:- Выбрать целевую аудиторию и цели документации.
- Определить состав (перечень артефактов) и формат документации.
- Собрать информацию об используемых технологиях: языки программирования, фреймворки, библиотеки, базы данных, облачные платформы.
- Собрать информацию об архитектуре приложения, каждой компоненте или подсистеме, их функциональности, взаимодействии с другими компонентами.
- Собрать информацию о конфигурации приложения, процессе развертывания и обновления.
- На основе собранной информации составить необходимую документацию.
- Проверить правильность и полноту документации, убедиться в ее четкости и легкости понимания.
- Утвердить документацию и сделать ее обязательной при выводе продукта в продуктовую среду.
- Довести документацию до сотрудников и разместить на внутреннем портале.
- Регулярно обновлять документацию в соответствии с изменениями в приложении и процессах.
Зона ответственности: Организация
Инструмент: -
Артефакт: Эксплуатационная документация
| Название | Severity | IP | Integral | |
|---|---|---|---|---|
| 1111111 111 11 1111 11111111111111111 1111111 1 11111111111111111 |
-
|
1 |
-
|
|
| 11 111111111 111 1111111111111111111111111 1111 1 11111 1111111 |
-
|
1 |
-
|
Мы используем cookie-файлы, чтобы получить статистику, которая помогает нам улучшить сервис для вас с целью персонализации сервисов и предложений. Вы может прочитать подробнее о cookie-файлах или изменить настройки браузера. Продолжая пользоваться сайтом, вы даёте согласие на использование ваших cookie-файлов и соглашаетесь с Политикой обработки персональных данных.