Лабораторная работа 3. Разработка перечня артефактов и протоколов проекта

1. Разработка перечня артефактов и протоколов проекта

2. Артефакты и протоколы

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

3. Артефакты и протоколы

Основные виды артефактов:
1. Документы требований:
• Спецификации функциональных
требований
• Технические задания
• Пользовательские истории (User
Stories)
2. Дизайн-документация:
• Архитектурные решения
• Прототипы интерфейсов
• Диаграммы классов, потоков
данных, процессов и др.
3. Кодовая база:
• Исходники программы
• Скрипты сборки и тестирования
• Контроль версий исходников

4. Артефакты и протоколы

4. Тестовые материалы:
• Тест-кейсы
• Отчеты по тестированию
• Лог-файлы ошибок
5. Отчетность и документация качества:
• Доклад о состоянии проекта
• Чеки проверки качества (Quality Assurance Checklists)
• Стандарты проектирования и кодирования
6. Архив результатов развертывания:
• Инструкция по установке и эксплуатации
• Руководства пользователей
• Обучающие видеоролики и презентации

5. Артефакты и протоколы

Для успешного составления списка необходимых артефактов рекомендуется
придерживаться следующего алгоритма:
1) Определите цели и задачи проекта.
Например, необходимость быстрой интеграции новых членов команды требует
наличия подробных инструкций и документации.
2) Проведите оценку уровня зрелости проектной группы.
Если команда состоит преимущественно из опытных профессионалов,
возможно уменьшение количества формальных документов.
3) Создайте карту зависимостей артефактов друг от друга, чтобы избежать
дублирования информации и потерь данных.
4) Включайте обязательные артефакты, необходимые для контроля качества,
управления рисками и поддержки дальнейшего развития системы.
5) Убедитесь, что каждый артефакт имеет понятное название, четкое
назначение и ясную структуру хранения.

6. Артефакты и протоколы

Протоколы регламентируют порядок действий участников проекта, включая
способы коммуникации, согласования решений и передачу ответственности.
Основные типы протоколов:
1. Рабочие протоколы: определяют сроки исполнения работ, процедуру
назначения исполнителей и критерии завершения заданий.
2.
Коммуникационные протоколы: регулируют формы взаимодействия
(например, использование мессенджеров, почты, конференц-звонков).
3.
Безопасносные протоколы: устанавливают правила защиты
конфиденциальной информации и ограничения доступа к ресурсам.
4.
Качества-протоколы: предписывают методы оценки соответствия
стандартам качества и процедуры внесения изменений.

7. Артефакты и протоколы

Протоколы взаимодействия играют ключевую роль в обеспечении
эффективной совместной работы всех участников программного проекта.
Эти протоколы представляют собой заранее установленные регламенты и
стандарты поведения, определяющие процессы принятия решений, обмен
информацией, взаимодействие команд и ответственность сотрудников.

8. Артефакты и протоколы

Типы протоколов взаимодействия:
1) Рабочие протоколы
• Рабочие протоколы задают чёткую последовательность действий и этапов
работы, начиная от постановки задач и заканчивая приёмкой выполненных
работ.
• Они включают в себя определение сроков исполнения задач, критериев
окончания каждой стадии проекта, форму отчетности и механизм
согласования решений. Важно определить степень детализации рабочих
протоколов исходя из масштаба и специфики проекта.
2) Коммуникационные протоколы
• Этот вид протоколов регулирует общение между участниками проекта,
будь то разработчики, менеджеры проектов, аналитики или клиенты.
• Здесь определяются предпочтительные инструменты коммуникаций (почта,
чаты, конференции), частота встреч и совещаний, уровни доступности
участников и права доступа к документам и сообщениям.
• Грамотно организованная коммуникационная структура минимизирует
вероятность возникновения проблем, вызванных недостатком информации
или её неправильным пониманием.

9. Артефакты и протоколы

3) Безопасные протоколы
• Безопасные протоколы необходимы для защиты конфиденциальной
информации и ресурсов проекта.
• Сюда входят инструкции по работе с секретными материалами, доступ к
которым ограничен определённым кругом лиц.
• Такие протоколы включают меры по предотвращению утечек данных,
защиту интеллектуальной собственности и организацию резервного
копирования важных файлов.
4) Протоколы качества
• Качество программного продукта зависит от соблюдения строгих
стандартов на каждом этапе его разработки.
• Поэтому нужны специальные протоколы, устанавливающие процедуры
оценки соответствия разработанного функционала требованиям заказчика,
прохождения тестов и исправления дефектов.
• Данные протоколы направлены на повышение надёжности и
эффективности всего проекта.

10. Артефакты и протоколы

5) Организационно-управленческие протоколы
• Организационно-управленческие протоколы содержат общие принципы
руководства проектом, распределения ролей и обязанностей среди членов
команды, описания механизмов разрешения конфликтов и вопросов
мотивации персонала.
• Это обеспечивает стабильность работы коллектива и поддерживает
высокий уровень производительности.

11. Артефакты и протоколы

Важные элементы протокола взаимодействия:
1) Определение ролей и зон ответственности
Четко обозначьте, кто за что отвечает, кто принимает ключевые решения и
кому делегированы полномочия. Такая практика помогает исключить
путаницу и конфликты относительно компетенции отдельных участников.
2) Регламентирование порядка обработки запросов и предложений
Установите стандартный процесс рассмотрения запросов и инициатив,
позволяющий быстро реагировать на изменения и новые идеи. Наличие
прозрачной схемы принятия решений повышает общую управляемость
проекта.
3) Механизм уведомления и оповещения
Опишите, каким образом участники будут получать важную информацию и
уведомляться о критичных событиях (например, изменении дедлайнов).
Регулярное информирование снижает вероятность возникновения
неожиданных ситуаций.

12. Артефакты и протоколы

4) Формат и содержание отчётности
Утвердите единые формы отчётов и рекомендации по оформлению
предоставляемых материалов. Эта мера упрощает обработку больших объёмов
информации и облегчает принятие управленческих решений.
5) Алгоритм реагирования на инциденты
Разработайте схему действий в чрезвычайных ситуациях (например, выход из
строя серверов или потеря ключевых данных). Эффективный кризисменеджмент предотвращает серьёзные последствия и уменьшает ущерб
проекту.

13. Артефакты и протоколы

При создании протоколов важно учитывать следующее:
• Описывать роли каждого участника процесса и уровень его полномочий.
• Использовать шаблоны для повышения согласованности процедур.
• Регулярно обновлять протоколы согласно изменениям условий и
технологий.
• Назначить ответственное лицо за соблюдение установленных правил.
Таким образом, разработка качественного перечня артефактов и грамотных
протоколов позволяет повысить эффективность работы команды, снизить
риски недопонимания и сбоев в проекте, а также способствует улучшению
общего качества конечного продукта

14. Артефакты и протоколы

Список артефактов программных проектов.
1) Бизнес-требования (Business Requirements):
• Документ описывает бизнес-задачи и ожидания клиента от
разрабатываемого программного продукта.
2) Технические требования (Technical Specifications):
• Содержит подробную техническую информацию о продукте, необходимую
команде разработки.
3) Диаграммы архитектуры (Architecture Diagrams):
• Графическое представление общей структуры системы, показывающее
компоненты, зависимости и потоки данных.
4) Проектные диаграммы (Project Charts):
• Включают визуализацию планов проекта, распределение задач и
расписание мероприятий.
5) Пользовательские сценарии (Use Cases):
• Детализирует конкретные случаи использования продукта пользователями,
помогая определить функциональные возможности и границы приложения.

15. Артефакты и протоколы

6) Файловая документация по API (API Documentation):
• Предоставляет подробное описание методов, параметров и возвращаемых
значений для сторонних разработчиков и интеграций.
7) Тест-планы и тест-кейсы (Test Plans & Test Cases):
• Фиксируют стратегию тестирования, набор проверок и ожидаемые
результаты для выявления возможных багов и несоответствий.
8) Руководства пользователя (User Manuals):
• Полезные инструкции по использованию продукта, включающие
пошаговые руководства и советы.
9) Отчётность по качеству (QA Reports):
• Формируются после завершения этапа тестирования и содержат
информацию о найденных ошибках, их серьезности и статусе устранения.
10) Контракты и соглашения (Contracts & Agreements):
• Юридически значимые документы, содержащие условия сотрудничества
между заказчиком и исполнителем.

16. Артефакты и протоколы

11) Исходный код (Source Code):
• Реализация функций и компонентов продукта на выбранном языке
программирования.
12) Скриптовые файлы автоматизации (Automation Scripts):
• Файлы, автоматизирующие рутинные операции, такие как сборка,
тестирование и деплоймент.
13) Лог-файлы и журналы ошибок (Log Files & Error Logs):
• Записи активности системы и выявленных ошибок, используемые для
диагностики и анализа неисправностей.
14) Документ о качестве продукции (Product Quality Document):
• Содержит сводку показателей качества программного продукта, собранных
на протяжении всей фазы разработки.
15) Перечень технических рисков (Risk Register):
• Перечисление потенциальных угроз и неопределенностей, влияющих на
успех проекта, вместе с мерами профилактики и планами смягчения
последствий.

17. Артефакты и протоколы

16) Модель базы данных (Data Model):
• Представляет структурированную картину базы данных, отображающую
таблицы, отношения и ограничения.
17) Резервные копии и архивы данных (Backups & Archives):
• Копии всех важных данных и документов, обеспечивающих восстановление в
случае потери или повреждения.
18) Стратегия выхода из кризиса (Crisis Management Plan):
• План действий на случай непредвиденных обстоятельств и аварийных
ситуаций, направленный на поддержание работоспособности системы.
19) Оценочные документы (Estimation Documents):
• Оценки затрат времени, ресурсов и бюджета на выполнение запланированных
задач.
20) Инструменты управления конфигурациями (Configuration Management Tools):
• Средства отслеживания версии, фиксации изменений и восстановления
предыдущих состояний системы.

18. Практическое задание:

Задание №1: Составьте список артефактов, необходимых для модуля
аутентификации пользователей. Укажите типы документов, которые требуются
для реализации и сопровождения данного модуля.
Задание №2: Подготовьте список артефактов для модуля интеграции с
платёжными системами. Укажите, какие именно артефакты потребуется создать
для успешной реализации интеграции
Задание №3: Определите перечень артефактов для модульного теста
логического компонента проекта. Укажите, какие дополнительные документы и
тесты понадобятся для покрытия функциональности компонента
Задание №4: Разработайте список артефактов для микросервисной
архитектуры. Рассмотрите различия в артефактах для монолита и
распределённой системы.
Задание №5: Подберите подходящий набор артефактов для отдельного UIкомпонента. Учтите возможные вариации внешнего вида и поведение
элементов графического интерфейса.

19. Благодарю за внимание