Представим, что вы планируете разработать большой проект: сайт, блог или приложение. Чего вы боитесь как заказчик? Что подрядчик пообещает золотые горы, возьмёт деньги, но не сделает, что вы хотели.
А как подрядчик? Что в начале работы вас попросят сделать одно, а в процессе — всё переделать (причём раз десять), в итоге вы потратите кучу времени и уйдёте в минус.
786 просмотров
Проект большой, поэтому надо принять меры. И поможет в этом спецификация (в простонародье — спека). В этой статье я расскажу, как готовить спецификацию к масштабному проекту, на примере нашей недавней работы с крупным клиентом.
Что такое спецификация?
Спецификация — это документ с набором требований, которым должен соответствовать разрабатываемый продукт. Весомый плюс этого документа — в экономии времени при разработке и гарантия спокойствия при согласовании.
Спека похожа на список продуктов перед походом в магазин. Запишите и структурируйте всё, чтобы не забыть «купить». Это по сути договор между вами и заказчиком, который регулирует объём будущих выполненных работ.
Работа со спецификациями в КОМПАС-3D. Инженерная практика, часть 19
Подготовку спецификации можно разделить на пять шагов.
1. Закрытая или открытая?
Открытая спецификация описывает требования к исполнению, но не указывает, как эти требования должны быть достигнуты. Такой формат удобен исполнителю: он свободен в выборе инструментов и в процессе может менять подходы.
Закрытая спецификация описывает не только способы достижения требований, но и инструменты/технологии, которые нужны при создании продукта. У закрытой спецификации больше плюсов для заказчика: весь процесс разработки становится прозрачным и более контролируемым.
Есть и средний вариант: полузакрытая спека (обычно заказчики и исполнители договариваются именно на такой компромисс). Вы описываете инструменты разработки только там, где их можно определить до начала работ.
2. Содержание
По структуре спецификация похожа на дипломную работу: элементы вроде содержания, введения или списка источников точно напомнят о студенческих временах.
Ну и какая спецификация без титульного листа! Добавьте на него заголовок и дату публикации — и всё, титульник готов.
Спецификация должна быть понятной, чтобы любой открывший её сразу понял, что и как нужно делать. Ниже приведу обязательные разделы, которые понадобятся при описании любого проекта. Если нужно, их можно пополнить подразделами.
- Введение
1.1 Обзор: цель спецификации.
1.2 Объём проекта: краткое описание проекта.
1.3 Глоссарий: расшифровка терминов.
1.4 Ссылки: список источников.
1.5 Обзор продукта: краткое описание каждого раздела
О последних двух подпунктах расскажу подробнее.
4. Функциональные и нефункциональные требования
Это основная и самая подробная часть спецификации. Ей нужно уделить особое внимание, но сначала разберёмся, в чём разница между этими требованиями.
Функциональные требования — то, как должна вести себя система, чтобы удовлетворить ожидания пользователя. В нашем проекте одной из функций была строка поиска. В её поведение закладывалось ранжирование результатов в хронологическом порядке. А если ничего не найдено, то пользователь получает рекомендацию изменить запрос.
Пример возможностей работы с таблицей спецификации оборудования в эксель
Ещё один пример: описание работы комментариев на сайте
Если функциональные требования определяют, что делает система, нефункциональные требования описывают, как она это делает. Это либо свойства, которые система должна демонстрировать, либо ограничения, которые она должна соблюдать. Например, веб-сайт не должен загружаться более 3 секунд.
Другой пример нефункционального требования — безопасности
Если продукт не соответствует нефункциональным требованиям, то он продолжает выполнять основные функции, но без удобства для пользователя.
5. Согласование
Для начала поставьте себя на место заказчика и прочитайте спецификацию его глазами. Скорректируйте текст, если нашли слабые или непонятные места.
Далее отдайте спеку заказчику на первую оценку. Возможно, согласование займёт несколько итераций, но это неотъемлемая часть работы.
Как только спека согласована, остаётся подписать её вместе с заказчиком и приступать к работе.
Можно использовать как шпаргалку, чтобы ничего не забыть:
Спецификация может показаться сложным документом, но без неё будет намного сложнее в самой разработке. А чтобы вам было полегче, можно скачать готовый шаблон
Источник: vc.ru
Шаблон спецификации по ГОСТ 19
Требования к структуре спецификации по ГОСТ 19 устанавливаются ГОСТ 19.202.
Спецификация в общем случае должна содержать разделы:
документация;
компоненты.
Наименование каждого раздела указывают в виде заголовка в графе «Наименование». Для документов, выполненных печатным способом, заголовок подчеркивают.
В раздел «Документация» вносят программные документы на данную программу, кроме спецификации и технического задания, в порядке возрастания кода вида документа, входящего в обозначение.
Далее записывают заимствованные программные документы. Запись их производится в порядке возрастания кодов организаций (предприятий) — разработчиков и далее в порядке возрастания кода вида документа, входящего в обозначение.
Примечание
Эти и другие требования к структуре и содержанию спецификации по ГОСТ 19 подробнее см. ГОСТ 19.202
Оформление документа
Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106, ГОСТ 19.202 и другими стандартами Единой системы программной документации (ЕСПД).
Источник: technicaldocs.ru
Спецификация требований к программному обеспечению
преподавателя, составление плана кафедры, выполнение плана кафедры. Печать отчетов.
Связь со сторонними ИС.
1. Введение
Разработать ПП «АРМ Кафедра», главная цель которого — автоматизация
документооборота на кафедре, а именно автоматизация планирования работы кафедры и
автоматизация отчетности работы преподавателя по ИПП.
1.2. Область применения
Использование данного продукта на любой кафедре как в ИрГУПС, так и в других высших и
средних учебных заведениях.
1.3. Термины и сокращения
SRS (Software Requirements Specifications ) – спецификация требований к ПО;
ИрГУПС – Иркутский Государственный Университет путей сообщения;
ИС – Информационные системы;
ПО – Программное обеспечение;
ЛВС — Локальная вычислительная сеть;
ВУЗ — Высшее учебное заведение;
ЭВМ – Электронно-вычислительная машина;
ЕБД – Единая база данных ( здесь: университета);
СУБД – Система управления базами данных;
MS IE – Microsoft Internet Explorer;
IEEE — Института инженеров по электротехнике и радиоэлектронике;
ИПП- Индивидуальный план преподавателя;
ПК – План кафедры;
ПП- программный продукт;
Документы – Индивидуальный план преподавателя и план кафедры;
Отчеты- Индивидуальный план преподавателя и план кафедры, представленные в
том виде, в котором они должны быть на печати.
Положение о планировании учебной, учебно-методической, научно-
исследовательской, организационно-методической и воспитательной работы в
Технологии разработки программного обеспечения: разработка сложных
программных систем. – 2-е изд. – СПб.: Питер, 2002. – 473с. – (Учебное пособие, в
качестве дополнительного источника информации);
Справочная информация по PHP:
www . php . net
Справочная информация по MySQL:
www . mysql . com
Справочная информация по Apache:
www . apache . com
Стандарты IEEE:
www.ieee.org
XHTML: учебный курс. – СПб.: Питер, 2001.-336с.:ил.
Гутманс Э., Бакен С., Ретанс Д.
PHP5. Профессиональное программирование.- Пер. с англ.- СПб.: Символ-Плюс,
2006.-704с.:ил.
HTML. Просто как дважды два.-М.: Изд-во Эксмо, 2006.-256с.:ил.
1.5. Обзор продукта