Разработка проектной документации на информационную систему (УП.05)

Для ознакомления со списком лекций, перейдите по ссылке.

Цель

Создать комплекс документов, который однозначно определяет, ЧТО должно быть разработано, КАК система будет функционировать и при каких условиях, служа основой для заключения договора на разработку и приемки готового продукта.

Структура проектной документации (Основные разделы)

Рекомендуемая структура для учебного проекта (УП.05), основанная на реальных стандартах (ГОСТ 34, ГОСТ 19):

1. Вводная часть (Общие положения)

• Наименование системы: Полное и сокращенное название ИС.
• Основание для разработки: Приказ по учебному заведению, номер задания на практику.
• Назначение системы: Краткое описание целей, бизнес-проблем, которые решает система (например: "Автоматизация обработки заказов в интернет-магазине").
• Цели и задачи создания системы:
  • Цели: Общие стратегические результаты (например: "Повысить скорость обслуживания клиентов на 30%").
  • Задачи: Конкретные действия (например: "Реализовать каталог товаров, учет складских остатков, оформление заказов").
• Перечень стадий и этапов разработки: План-график работ (например: проектирование, разработка, тестирование, внедрение).

2. Требования к системе

Это самый объемный раздел.

• 2.1. Функциональные требования: Что система должна делать, структурируются по модулям или ролям пользователей, например:
• Для менеджера:
  • ФР.1. Добавление клиента.
  • ФР.2. Просмотр и редактирование товара.
  • ФР.3. Формирование отчета "Продажи".
• 2.2. Требования к надежности: Время безотказной работы (например, 99.5%), восстановление (не более 30 минут).
• 2.3. Требования к безопасности: Разграничение прав доступа, требования к паролям, шифрование данных.
• 2.4. Требования к эргономике и интерфейсу: Интуитивный интерфейс, обучение не более 2 часов.
• 2.5. Требования к совместимости и интеграции: Интеграция через REST API, экспорт отчетов в XLSX и PDF.

3. Описание системы

• 3.1. Архитектура системы: Схема компонентов (клиент, сервер, база данных) и связи.
• 3.2. Программно-технические средства: ОС, СУБД, сервер приложений, браузеры.
• 3.3. Структура базы данных: Модель данных (ER-диаграмма) и описание таблиц.

4. Состав и содержание работ по созданию системы

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

5. Порядок контроля и приемки системы

• 5.1. Виды испытаний: Предварительные (разработчик), приемочные (заказчик).
• 5.2. Порядок приемки: Система считается принятой при успешном прохождении испытаний и подписании Акта приемки.

6. Экономическая эффективность

Краткий расчет затрат, экономии и срока окупаемости (см. предыдущий материал).

Процесс разработки документации (Пошаговый план)

1. Анализ и структурирование исходных данных: Собрать все материалы, сгруппировать по разделам ТЗ.
2. Формализация требований: Превратить пожелания в четкие, проверяемые требования.
3. Проектирование архитектуры и моделей: Сделать схему архитектуры, создать ER-диаграмму.
4. Написание текста документа: Использовать ясный, однозначный технический язык.
5. Согласование и утверждение: Представить проект руководителю, внести правки, получить подпись и утверждение.

Типичные ошибки и рекомендации для УП.05

• Ошибка: Размытые требования.
• Решение: Форматировать требования как: "Система должна позволять [роль] выполнять [действие]".
• Ошибка: Отсутствие критериев приемки.
• Решение: Для каждого требования определить проверяемый критерий.
• Ошибка: Игнорирование нефункциональных требований.
• Решение: Выделить их отдельно.
• Рекомендации: Используйте схемы и диаграммы — это ускоряет понимание и делает документ более понятным.

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