 |
Требования к программной документации
|
|
|
|
Введение
Настоящее техническое задание распространяется на разработку программного продукта (выбрать конкретный термин из следующих возможных вариантов - программы, программного комплекса, программной системы), (далее – название), используемого для (описание функционального назначения продукта) и предназначенного для (описание области применения и возможных пользователей).
(Далее приводится обоснование актуальности разработки, её место в ряду подобных).
Основания для разработки
Разрабатывается:
- или в соответствии с договором, приказом, распоряжением, заявкой и т.п., если разработка ведется по плану работы некоторой организации;
Назначение разработки
Основное назначение (название) заключается в (описание функционального и эксплуатационного назначения программного продукта с указанием категорий пользователей).
Исходные данные, цели и задачи
Исходные данные
4.1.1 Исходными данными для разработки являются описание функционального и эксплуатационного назначения, (см. пункт 3), а также следующие материалы:
4.1.1.1 (перечень работ или письменных документов) …
4.1.1.2 (перечень прототипов) …
4.1.1.3 Конкретные числовые параметры: например, количество документов, допустимое время обработки, максимальное время ожидания можно сослаться на п. 5.1.2.
Цель работы
Целью работы является (дистрибутивная версия, прототип, проект и т.п.) (Наименование) для (кратко функциональное и эксплуатационное назначение).
Решаемые задачи
4.3.1 Выбор (модели жизненного цикла, архитектуры, подхода, технологии, методов, стандартов и средств разработки, если они не указаны в техническом задании).
4.3.2 Анализ требований технического задания с точки зрения выбранной технологии и уточнение требований к информационной системе: техническим средствам, внешним интерфейсам, а также к надежности и безопасности.
|
|
|
4.3.3 Исследование предметной области – разработка или выбор моделей, описывающих предметную область, или математическая постановка основных задач и/или выбор методов решения этих задач.
4.3.4 Определение архитектуры информационной системы: разработка ее структуры; определение набора необходимого оборудования, программного обеспечения и процессов обслуживания.
4.3.5 Анализ требований технического задания и разработка спецификаций проектируемого программного обеспечения.
4.3.6 Разработка структуры программного обеспечения и определение спецификаций его компонентов (описание модулей).
4.3.7 Проектирование компонентов (конкретное название программного продукта; отдельно указать, если есть, базы данных, подсистемы и т.п.).
4.3.8 Реализация компонентов с использованием выбранных средств и их автономное тестирование.
4.3.9 Сборка (конкретное название программного продукта) и его комплексное тестирование.
4.3.10 Оценочное тестирование (указать конкретно виды тестирования, например, тестирование удобства использования, тестирование на предельных нагрузках и т.п.).
5 ТРЕБОВАНИЯ К (название)
Требования к функциональным характеристикам
Выполняемые функции
5.1.1.1 Для пользователя:
- функция 1;
- функция 2 и т.д.
5.1.1.2 Для администратора системы (если он предусматривается):
- функция 1;
- функция 2 и т.д.
5.1.2 Исходные данные:
- информация 1;
- информация 2 и т. д.
- можно повторить п. 4.11.3
5.1.3 Результаты:
- информация 1;
- информация 2 и т.д.
(здесь же указывают максимально допустимое время ответа системы, максимальный объем используемой оперативной и/или внешней памяти и т.п.)
Требования к надежности
5.2.1 Предусмотреть контроль вводимой информации.
|
|
|
5.2.2 Предусмотреть защиту от некорректных действий пользователя.
5.2.3 Обеспечить целостность информации в базе данных.
(Кроме того, можно указать требования к восстановлению после сбоев, например, время восстановления системы, наличие контрольных точек, резервных копий полученных промежуточных результатов и т.п.)
Условия эксплуатации
5.3.1 Условия эксплуатации в соответствие с СанПин 2.2.2.542 – 96.
5.3.2 Обслуживание
5.3.3 Обслуживающий персонал
(при необходимости указывают основные операции обслуживания, необходимые количество и квалификацию персонала).
Требования к составу и параметрам технических средств
5.4.1 Программное обеспечение должно функционировать на IBM-совместимых персональных компьютерах.
5.4.2 Минимальная конфигурация технических средств:
5.4.2.1 Тип процессора...................................................................................... Pentium.
5.4.2.2 Объем ОЗУ................................................................................................. 32 Мб.
5.4.2.3
5.5 Требования к информационной и программной совместимости
5.5.1 Программное обеспечение должно работать под управлением операционных систем (например, семейства Windows’2000).
5.5.2 Входные данные должны быть представлены в следующем формате: (описание формата).
5.5.3 Результаты должны быть представлены в следующем формате: (описание формата).
5.5.4 Программное обеспечение должно (описание интерфейса (протокола) с другим программным обеспечением).
Можно также указать средства: язык и среду разработки, а также требования к защите информации.
Требования к маркировке и упаковке
Требования к маркировке и упаковке не предъявляются.
Требования к транспортированию и хранению
Требования к транспортировке и хранению не предъявляются.
Специальные требования
Сгенерировать установочную версию программного обеспечения.
Требования к программной документации
6.1 Разрабатываемые программные модули должны быть самодокументированы, т.е. тексты программ должны содержать все необходимые комментарии.
6.2 Разрабатываемое программное обеспечение должно включать справочную систему. 6.3 В состав сопровождающей документации должны входить:
6.3.1 Расчетно-пояснительная записка на 100 листах формата А4 (без приложений 6.3.2, 6.3.3 и 6.3.4).
|
|
|
6.3.2 Техническое задание (Приложение 1).
6.3.3 Руководство пользователя (Приложение 2).
6.3.4 Руководство системного программиста (Приложение 3).
6.4 Графическая часть минимально должна быть выполнена на 5 листах для бакалавра и 8 листах для инженеров и магистров формата А1 (копии формата А3, А4 включить в качестве приложений к расчетно-пояснительной записке):
Виды графической документации: (выбрать нужные):
- Схема структурная информационной системы.
- Спецификация функциональная.
- Схема структурная программного обеспечения.
- Схема функциональная программного обеспечения.
- Функциональная диаграмма программного обеспечения (или его части).
- Диаграмма потоков данных программного обеспечения или его части.
- Диаграммы (схемы) компонентов структур данных.
- Структуры (модели) знаний.
- Схемы (модели) процессов (методов формирования результатов, механизмы выводов и т.п.).
- Схемы (модели) синтаксического, семантического представления (языка входных и выходных сообщений и т.д.).
- Диаграмма вариантов использования.
- Концептуальная модель предметной области.
- Схемы взаимодействия объектов, объектная декомпозиция.
- Схемы структурные компонент, например, даталогическая и/или инфологическая схемы базы данных.
- Схема взаимодействия модулей.
- Диаграммы классов предметной области и/или интерфейсной части программного обеспечения.
- Граф (диаграмма) состояний интерфейса.
- Структурная схема меню.
- Графы диалогов.
- Формы интерфейса.
- Схемы алгоритмов модулей (подпрограмм).
- Диаграммы компоновки программных компонентов.
- Диаграммы размещения программных компонентов.
- Таблица характеристик (инструментальных средств разработки, языка, среды программирования, средств автоматизации разработки, методов тестирования, подхода к разработке).
- Таблицы тестов.
- Схемы алгоритмов тестовых программ.
- Схема алгоритма тестирования.
- Схема процесса разработки программного продукта (при различных технологиях, например, при структурном, объектном, нисходящем, восходящем подходах и т.п.).
- Таблица характеристик качества программного обеспечения.
|
|
|
