Похожие презентации:
12. Шаблоны и документация
1. Шаблоны и документация
ШАБЛОНЫ И ДОКУМЕНТАЦИЯ2. Список документации
Документация для разрабатываемого приложения играет важную роль вуспехе проекта, помогая команде разработчиков понимать требования и цели
продукта, а пользователям — грамотно пользоваться возможностями
приложения. Ниже представлен рекомендуемый перечень документов,
которые желательно подготовить для качественного программного продукта:
1. Концептуальная документация (Vision Document)
• Назначение документа: описывает видение конечного результата, ключевые
характеристики и целевую аудиторию продукта.
• Что должно содержаться: миссия продукта, основная идея, конкурентные
преимущества, перспективы развития.
2. Бизнес-требования (Business Requirements Document, BRD)
• Назначение документа: формирует общие бизнес-правила и потребности
заказчика.
• Что должно содержаться: описание потребностей бизнеса, ключевых
функциональных возможностей, ожидаемых результатов.
3. Список документации
3. Технические требования (Technical Requirements Specification, TRS)• Назначение документа: формулировка технических характеристик и
ограничений, определяющих рамки разработки.
• Что должно содержаться: спецификация железа, требования к языку
программирования, среде разработки, инфраструктуре сервера и
клиентской стороны.
4. Проектная документация (Software Design Specification, SDS)
• Назначение документа: техническое проектирование и описание
внутренней архитектуры решения.
• Что должно содержаться: диаграммы UML, описание модулей,
интерфейсов, структуры данных, паттернов проектирования.
5. Пользовательская документация (User Manual)
• Назначение документа: руководство пользователя, объясняющее базовые
операции и функциональные возможности.
• Что должно содержаться: пошаговая инструкция по установке, настройке и
основным действиям пользователей.
4. Список документации
6. Руководство администратора (Administrator Guide)• Назначение документа: документ для ИТ-специалистов, обеспечивающих
установку, обновление и техническую поддержку приложения.
• Что должно содержаться: инструкции по развертыванию,
конфигурированию, созданию бекапа, восстановлению, решению проблем.
7. Тестовая документация (Test Plan and Test Cases)
• Назначение документа: планы и сценарии тестирования для оценки
качества функционала.
• Что должно содержаться: тест-план, набор тест-кейсов, стратегии
тестирования (функциональное тестирование, интеграционное
тестирование, стресс-тестирование и т.д.)
8. Документ миграции (Migration Plan)
• Назначение документа: план перехода от старой версии продукта или
аналогичного инструмента к новому продукту.
• Что должно содержаться: подробный план действий по миграции данных,
конфигурации, настройки окружения.
5. Список документации
9. Отчет о качестве (Quality Assurance Report)• Назначение документа: отчет по итогам тестирования и оценки качества
продукта.
• Что должно содержаться: статистика найденных дефектов, общая оценка
готовности релиза, рекомендации по улучшению.
10. План выпуска (Release Plan)
• Назначение документа: расписание релизов и план подготовки финальной
версии продукта.
• Что должно содержаться: график выпусков версий, этапы стабилизации,
процедуры регрессии, правила публикации обновлений.
11. FAQ (Frequently Asked Questions)
• Назначение документа: сборник часто задаваемых вопросов и ответов.
• Что должно содержаться: список типичных вопросов пользователей и
четких ответов на них.
12. Приложение чекаутов (Checklist Application)
• Назначение документа: чек-листы для запуска и проверок
работоспособности продукта.
• Что должно содержаться: списки процедур для проверки корректности
установки, базовых конфигураций и работоспособности приложения.
6. Концептуальная документация
Ниже приведён пример шаблона концептуальной документации дляразрабатываемого программного обеспечения согласно ГОСТ 19.201-78 и
другим стандартам, принятым в России.
Концептуальная Документация (Vision Document)
1. Название документа
Название документа: Концептуальная документация на программное
обеспечение «Имя приложения»
2. Общие положения
2.1. Цели и назначение
Определить цель разработки и основное предназначение программного
обеспечения, описать сферу применения и решаемые задачи.
Пример текста: «Программа предназначена для автоматизации учёта рабочего
времени сотрудников предприятия. Основное назначение – ведение учета
отработанного времени сотрудниками, формирование отчётности и
интеграция с системами кадрового учёта.»
7. Концептуальная документация
2.2. Целевые пользователиПеречислить категории пользователей, которым предназначается данное ПО.
Пример текста: «Система ориентирована на руководителей подразделений,
кадровых работников, бухгалтеров и сотрудников предприятия,
заинтересованных в получении актуальной информации о рабочем времени.»
2.3. Предполагаемая сфера применения
Указать отрасли экономики, регионы или конкретные сферы, где
предполагается внедрение и эксплуатация программного обеспечения.
Пример текста: «Продукт предназначен для предприятий малого и среднего
бизнеса, коммерческих организаций и государственных учреждений,
осуществляющих учет рабочего времени сотрудников.»
8. Концептуальная документация
3. Функциональные требованияЗдесь перечисляются основные функции и возможности будущего ПО.
Пример текста:
• Учёт отработанных часов сотрудников;
• Формирование ежедневных, еженедельных и ежемесячных отчётов;
• Экспорт данных в форматы Excel, PDF;
• Интеграция с корпоративными порталами HR-служб;
• Авторизация и защита данных.
4. Требования к надёжности и качеству
Формулируются критерии качества и показатели надёжности программного
обеспечения.
Пример текста:
• Время реакции системы на запросы пользователей: не более 3 сек.;
• Средний показатель отказоустойчивости: не ниже 99%;
• Гарантия бесперебойной работы в течение гарантийного срока.
9. Концептуальная документация
5. Требования к эксплуатационным характеристикамОпределяются условия эксплуатации, аппаратные и программные требования.
Пример текста:
• Операционная система: Windows 10, macOS 11+;
• Минимальные аппаратные требования: процессор Core i5, RAM 8GB, HDD
1TB;
• Интернет-подключение: рекомендуется подключение на скорости не менее
10 Мбит/с.
6. Интерфейс пользователя
Краткое описание внешнего вида интерфейса и удобства пользования.
Пример текста: Интерфейс программы реализован в стиле Material Design с
поддержкой тёмной и светлой тем оформления. Пользователи смогут
просматривать информацию и вводить данные интуитивно понятным
способом.
10. Концептуальная документация
7. Планируемые сроки и бюджетПриводится предварительный план работ и ориентировочная стоимость
проекта.
Пример текста:
Этапы разработки:
Подготовительный этап: исследование рынка, постановка задач – 1 месяц;
Разработка первой версии продукта: 6 месяцев;
Тестирование и исправление багов: 2 месяца;
Выпуск бета-версии: 1 месяц;
Полноценный запуск: 1 месяц.
Итого: общий срок разработки составляет около 11 месяцев.
Предварительная сумма затрат на проект: 5 млн рублей.
11. Концептуальная документация
8. Заключительные положенияВ данном разделе содержатся дополнительные важные замечания и правовые
оговорки, касающиеся авторских прав, конфиденциальности и иных условий.
Пример текста:
Все материалы, содержащиеся в документе, защищены законом об
интеллектуальной собственности. Любое копирование материалов без
согласия правообладателя недопустимо.
12. Технические требования
Документ технических требований (Technical Requirements Specification):1. Общие положения
• Название документа: Технические требования на разработку программного
обеспечения «Название продукта».
• Разработчик: [название организации-разработчика].
• Заказчик: [название организации-заказчика].
• Утверждено: [дата утверждения], [подпись руководителя].
• Исполнитель: [ФИО исполнителя].
13. Технические требования
2. Основание для разработкиКраткая ссылка на приказ, договор или иной документ, послуживший
основанием для разработки данного ПО.
Пример текста:
Настоящее техническое задание составлено на основании договора № ХХХХ
от XX.XX.XXXX г., заключённого между ООО «Разраб» и АО «Клиент».
3. Назначение и область применения
Необходимо сформулировать основную цель и область применения
создаваемого ПО.
Пример текста:
Назначение: Автоматизация процесса формирования отчетности по продажам
и контролю товарных запасов в торговых предприятиях.
Область применения: Продукт предназначен для средних и малых компаний
розничной торговли и дистрибьюторских сетей.
14. Технические требования
4. Характеристики объекта автоматизацииПодробно опишите существующий процесс, подлежащий автоматизации, его
слабые места и ожидаемые изменения после внедрения нового ПО.
Пример текста:
На сегодняшний день сотрудники занимаются ручной обработкой данных по
продажам и остаткам товаров, что занимает значительное время и приводит к
ошибкам. Новая система призвана упростить и ускорить процесс сбора и
обработки данных, снизить затраты труда и сократить риск возникновения
ошибок.
5. Требования к функциональным возможностям
Детализированное изложение перечня основных функций и требований к ним.
Пример текста:
• Автоматическое получение данных о продажах из кассовых аппаратов.
• Генерация стандартных отчетов по продажам, оборотам и прибыльности.
• Отображение остатков товара на складе и складах филиалов.
• Отправка уведомлений менеджерам о низком уровне запасов продукции.
• Предоставление графической визуализации показателей (графики,
диаграммы).
15. Технические требования
6. Требования к техническим средствамОпишите минимальные и рекомендованные требования к оборудованию и
средам, необходимым для эксплуатации ПО.
Пример текста:
Минимальные требования:
• Операционная система: Windows 10 Professional и выше, macOS Big Sur и
выше.
• Центральный процессор: Intel Core i5/i7 или AMD Ryzen 5 и выше.
• Объем оперативной памяти: 8 ГБ и выше.
• Свободное место на жестком диске: минимум 1 ГБ.
• Доступ в интернет: HTTP(S)-подключения.
Рекомендуемые требования:
• Центральный процессор: Intel Core i7/i9 или AMD Ryzen 7 и выше.
• Объем оперативной памяти: 16 ГБ и выше.
• SSD-накопитель: предпочтительно NVMe.
16. Технические требования
7. Требования к информационной защитеОпишите меры информационной безопасности и защиты данных.
Пример текста:
• Все передаваемые данные шифруются с использованием SSL/TLS
протоколов.
• Система аутентификации пользователей с контролем паролей и
обязательной двухфакторной аутентификацией.
• Регулярное резервное копирование данных с возможностью
восстановления.
• Ограничение доступа к определенным модулям системы в зависимости от
роли пользователя.
8. Требования к надежности и устойчивости
Опишите обязательные требования к уровню доступности и
отказоустойчивости ПО.
Пример текста:
• Среднее время наработки на отказ (MTBF) — не менее 10 тысяч часов.
• Вероятность успешного завершения транзакций — не менее 99%.
• Доступность сервиса — не менее 99% в сутки.
17. Технические требования
9. Порядок сдачи-приёмкиОпределите порядок приемки готового ПО заказчиком, формы подтверждения
соответствия требованиям и ответственность сторон.
Пример текста:
Сдача и приёмка проводятся комиссией в составе представителей Заказчика и
Исполнителя. Результаты испытаний оформляются актом сдачи-приемки,
подписанным обеими сторонами.
10. Прочие положения
Дополнительные пункты и примечания, если они необходимы.
Пример текста:
Внесение изменений в настоящее техническое задание производится
дополнительным соглашением сторон.
18. Технические требования
11. Перечень исполнителейСписок лиц, участвующих в проекте и ответственных за выполнение
конкретных этапов.
Пример текста:
19. Технические требования
12. ПриложенияВ данном разделе указываются дополнения, чертежи, графики, схемы и прочие
вспомогательные материалы.
13. Завершающие положения
Завершают документ подписи уполномоченных лиц, печать организации и
отметка о согласовании с руководством.
Пример текста:
• Руководитель подразделения (должность, подпись, расшифровка подписи)
• Главный инженер (должность, подпись, расшифровка подписи)
• Согласовано: Дата согласования.
20. Пользовательская документация
Ниже представлен шаблон пользовательской документации дляразрабатываемого программного обеспечения (ПО) в соответствии с ГОСТ
19.505-79 и другими государственными стандартами РФ.
1. Титульный лист
• Название документа: Руководство пользователя ПО «Название
программы».
• Версия руководства: [номер версии].
• Ответственный исполнитель: [ФИО исполнителя].
• Утверждение документа: [дата утверждения].
• Место печати: [организация-исполнитель].
2. Аннотация
Общая характеристика документа и предназначение ПО.
Пример текста:
«Настоящий документ предназначен для ознакомления пользователей с
функциями и особенностями использования программного обеспечения
„Название программы“. Он служит руководством по выполнению
повседневных задач, возникающих при эксплуатации программы.»
21. Пользовательская документация
3. Общие положенияКраткое введение в суть ПО и цели его создания.
Пример текста:
«„Название программы“ — специализированное программное решение,
предназначенное для автоматизации бухгалтерского учета и управленческой
отчетности на предприятии средней величины. Основная задача программы —
систематизация финансовой информации и снижение трудозатрат на
подготовку отчетов.»
4. Инструкция по установке и настройке
Четкое описание шагов по инсталляции и первичной настройке ПО.
Пример текста:
1. Скачать установочный пакет с официального сайта.
2. Запустить скачанный файл установки.
3. Следовать подсказкам мастера установки.
4. После успешной установки запустить программу и ввести лицензионный
ключ.
5. Проверить правильность ввода данных и подтвердить ввод кнопкой ОК.
22. Пользовательская документация
5. Описание элементов интерфейсаКраткое описание окна программы, меню, панелей инструментов и рабочих
окон.
Пример текста:
1. Главное окно программы содержит панель навигации слева, рабочую зону
справа и строку статуса внизу экрана.
2. Панель навигации содержит кнопки быстрого доступа к основным
функциям.
3. Рабочая зона отображает текущие документы и формы для заполнения.
4. Строка статуса показывает статус выполняемой операции и
диагностические сообщения.
23. Пользовательская документация
6. Основные функции и работа с нимиШаг за шагом расписаны основные функции и инструкции по их применению.
Пример текста:
• Создание нового документа:
Нажмите кнопку «Новый документ» на панели навигации → выберите вид
документа → заполните поля → сохраните документ.
• Редактирование существующих документов:
Найдите нужный документ в списке → откройте его → внесите изменения →
сохраните изменения.
• Удаление документов:
Выберите ненужный документ → нажмите кнопку удаления → подтвердите
удаление.
24. Пользовательская документация
7. Примеры работы с программойПримеры конкретных задач, решаемых с помощью ПО.
Пример текста:
Рассмотрим процедуру создания отчета по заработной плате:
1. Открыть модуль «Зарплата».
2. Выбрать период отчетности.
3. Заполнить форму начисления зарплаты.
4. Сохранить отчет и вывести его на печать.
8. Возможные ошибки и пути их устранения
Классификация возможных сбоев и неполадок с путями их разрешения.
Пример текста:
• Ошибка подключения к базе данных: проверьте наличие соединения с
сетью и перезагрузите компьютер.
• Поврежденный файл лицензии: переустановите лицензию, обратившись в
службу поддержки.
• Нет связи с принтером: убедитесь, что принтер подключен и включен,
попробуйте повторно отправить документ на печать.
25. Пользовательская документация
9. Безопасность и сохранность данныхПравила безопасной работы с информацией и сохранения данных.
Пример текста:
• Регулярно делайте резервные копии данных.
• Не оставляйте пароль от аккаунта доступным посторонним лицам.
• Выходите из программы после окончания работы.
10. Контрольные вопросы и тесты
Вопросы для проверки усвоения материала пользователями.
Пример текста:
• Какие три шага нужно сделать для создания нового документа?
• Где находится кнопка выхода из программы?
• Как удалить поврежденный файл лицензии?
26. Пользовательская документация
11. Алфавитный указательАлфавитный список терминов и сокращений с указанием страниц.
Пример текста:
• Аналитика данных — стр. 20
• Автоматизация расчета зарплаты — стр. 25
• Архивация данных — стр. 30
• Безопасность данных — стр. 35
12. Заключение
Заключение по руководству пользователя и возможные направления
дальнейших разработок.
Пример текста:
Настоящая документация охватывает основные аспекты работы с программой
«Название программы». Рекомендуем регулярно проверять обновления
программы и обращаться в службу поддержки при возникновении вопросов.
27. Пользовательская документация
Завершающие положенияЗаключительная часть документа содержит отметки о проверке и утверждении
документации ответственными лицами.
Пример текста:
Следуя данному шаблону, вы обеспечите полноту и ясность пользовательского
руководства, соответствующего нормам ГОСТ и способствующего
комфортной эксплуатации вашего программного продукта.
28. Задания
Составьте концептуальную и пользовательскую документацию и техническиетребования в соответствии с шаблонами по следующим ПО:
№1: Система учета рабочего времени сотрудников (TimeTracker)
Назначение:
Система TimeTracker разработана для автоматизации учета рабочего времени
сотрудников в организациях разного масштаба. Основной целью является
повышение точности учета рабочего времени, облегчение планирования
рабочей нагрузки и оптимизация трудового процесса.
Основные функции:
• Учёт рабочего времени: регистрация прихода и ухода сотрудников с
помощью электронной карты или биометрических данных.
• Контроль отсутствий: фиксация прогулов, больничных листов, отпусков и
командировок.
• Формирование отчётов: автоматическое составление ежедневных,
недельных и месячных отчетов по рабочему времени сотрудников.
• Интеграция с CRM и ERP-системами: синхронизация данных с другими
информационными системами предприятия.
• Управление правами доступа: настройка уровней доступа сотрудников к
системе в зависимости от должности и обязанностей.
29. Задания
№2: CRM-система «ManagerPro»Назначение и задачи:
CRM-система ManagerPro предназначена для автоматизации и оптимизации
процессов взаимоотношений с клиентами в компаниях различного профиля и
масштабов. Главная цель системы — улучшение обслуживания клиентов,
повышение эффективности продаж и маркетинга, а также уменьшение
временных и трудовых затрат на рутинные задачи.
Ключевые функции:
• Управление контактами;
• Автоматизация продаж;
• Маркетинг и коммуникации;
• Сервис и поддержка клиентов;
• Отчеты и аналитика;
• Настройки и администрирование;
30. Задания
№3: «CalcusPRO»Консольный калькулятор на языке Python, который демонстрирует
элементарные арифметические операции и может служить базой для
понимания основ программирования
По данным ПО составить три вида документации в соответствии с
шаблонами. Каждый пункт документации должен начинаться с новой
страницы.
Требования по оформлению:
• Шрифт – Times New Roman;
• Отступ слева – 1,5, отступ справа – 0,5;
• Абзацы начинаются с табуляции;
• Размер шрифта: для заголовков – 16, для текста – 14;