Примерный шаблон функциональной спецификации
Функциональная спецификация
[название проекта, программного продукта]
[дата создания]
[дата модификации]
История изменения
[дата] [Имя] [краткое описание изменений и дополнений. Пример: Добавлена поддержка NTSC в разделе “Форматы”]
Запрос заказчика
Здесь вы копируете текст заказчика “буква в букву”. Этот текст является частью спецификации. Это базовое видение заказчиком функциональности, которое вами потом детализируется, уточняется, дополняется в следующих разделах спецификации. При этом ни одно предложение заказчика не игнорируется.
Требования (если есть таковые)
Требования к программному обеспечению. Здесь указываются библиотеки, которые необходимы для работы или разработки функциональности. Программы, которые необходимо установить для работы функции. Требования к минимальной операционной системе, необходимой для работы функции.
Примеры:
- Библиотека (.dll) для экспортирования графических файлов.
- MSXML для экспорта и импорта файлов формата XML.
- Internet Explorer 5 для правильной адресовки панели инструментов.
- Quick Time для Windows для проигрывания видео.
Также стоит указать требования к аппаратному обеспечению, если есть такая необходимость. В итоге, совокупность требований для всех функций становится требованием для программного продукта.
Пользовательский интерфейс и поведение программы
Это самый главный раздел. В этом разделе вы описываете, как функция будет доступна пользователю. Т.е. указываете все интерфейсные решения, с помощью которых пользователь будет использовать функцию. Это видимая, для пользователя, часть функции. Здесь, как правило, описываются:
- команды меню;
- кнопки на панели инструментов;
- диалоговые окна;
- новые элементы в существующих диалогах;
- элементы документа программы, и т.д.
Очень хорошо здесь показать эскизы. Эскизы очень упрощают восприятие информации.
Так же в этом разделе вы должны указать поведение программы, взаимодействие элементов интерфейса, значения по умолчанию.
Пример: "Кнопка "Плот" будет доступна только в том случае, если вы выбираете 2 или 3 пункта в списке "Сегменты".
Обработка ошибок
Здесь вы описываете все возможные ошибочные действия пользователя, и противоречивое поведение программы. И указываете решения этих проблем. А именно:
- перечисляете тексты сообщений об ошибках для каждой противоречивой ситуации;
- перечисляете проблемы, которые вы будете просто игнорировать (если вероятность и эффект проблемы очень малы, а решить проблему очень сложно);
- автоматическое исправление ошибки без сообщения об ошибке. Пример: “Если уравнение полностью не описано в диалоге "Определение Уравнения", то остальные элементы диалога остаются неактивными.”
Оценки
Здесь вы указываете оценки на:
- программирование;
- тестирование;
- дизайн;
- функции.
Оценки необходимо пересматривать каждый раз, когда вы вносите изменения в спецификацию.
Пример функциональной спецификации
1 Функциональная Спецификация
Проект: Программа просмотра файлов File viewer
23 августа 2012 г.
2 Запрос заказчика
Разработать приложение, которое позволяет просматривать и распечатывать файлы программ. Поддерживаемые форматы файлов:
- v1;
- v2;
- v3.
Программа будет поддерживать "Нормальные" и "Компактные" форматы файлов.
Программа будет игнорировать попытку открыть файл неподдерживаемого формата.
3 Системные требования
К разрабатываемому программному продукту предъявляются следующие системные требования:
- Windows 2000/NT/XP/7/Vista/8;
- любой процессор, 1.60 ГГц или выше;
- 256 Мб ОЗУ или более;
- 64 Мб или более свободного места на жестком диске;
- монитор, поддерживающий разрешение 800x600 или выше.
4 Пользовательский интерфейс и поведение программы
Основные функции программы показаны на рисунке 1.
Рисунок 1 – Функциональная архитектура
4.1 Стартовый диалог
При запуске программа будет показывать диалоговое окно приветствия:
---Добро пожаловать в Программу просмотра ---
[текст]
[OK]
При нажатии OK будет закрыто стартовое диалоговое окно и откроется диалоговое окно Открыть Файл.
4.2 Меню и команды
4.2.1 Меню Файл предназначено для выполнения основных управляющих действия над файлами.
Меню Файл содержит команды:
- Открыть – открывает файл, выделенный пользователем в диалоговом окне Открыть Фай; имя файла для открытия может быть выбрано щелчком мыши из предложенного списка или введено в поле Имя файла; при выборе пользователем файла недопустимого формата (клик мыши или ввод с клавиатуры) система подает сигнал.
- Настройка печати – позволяет выбрать принтер, диапазон печати, и количество копий печати; File viewer позволит распечатать текущий лист, текущий раздел или весь файл;
- Печать – отправка документа на выбранный принтер; в таблицах всегда печатается сетка таблицы и никогда не печатаются заголовки таблиц (печать заголовков полезна, только если вы работаете над проектом и нужно следить за датами и файлами, однако это не проблема, если вы печатаете из программы просмотра);
- Выход – закрытие программы с подтверждением сохранения изменений.
4.2.2 Меню Правка предназначено для …; содержит команды:
- [список команд].
4.2.3 Меню Вид предназначено для …; содержит команды:
- [список команд].
4.2.4 Меню Изменения предназначено для …; содержит команды:
- [список команд].
4.2.5 Меню Окна предназначено для …; содержит команды:
- [список команд], [список открытых в настоящее время документы].
4.2.6 Меню Справка предназначено для …; содержит команды:
- [список команд].
4.3 Панели инструментов, навигации по документу
Кнопки панели инструментов соответствуют определенным командам меню. Все кнопки панели инструментов будут иметь всплывающие подсказки.
4.3.1 Панель ярлыков содержит кнопки:
- Открыть – соответствует команде Открыть меню Файл; текст подсказки «Открыть файл»;
- Распечатать – соответствует команде Печать меню Файл; текст подсказки «Печать файла».
4.3.2 Панель навигации содержит кнопки: [список кнопок].
4.3.3 Панель инструментов форматирования содержит кнопки: [список кнопок].
4.5 ДИЗАЙН
Программа "File viewer" будет иметь уникальный значок.
4.6 УСТАНОВКИ
File Viewer будет устанавливаться с помощью файла установки InstallProgram в папку "Program Files...Viewer". Установщик будет создавать ярлык Viewer на рабочем столе и ярлык Viewer в меню "Пуск–Программы". Установщик создаст утилиту удаления программы в папку "Program Files...Viewer" и в меню "Установка и удаление Программ" Панели Управления.