Шаблон спецификации требований к ПО — К. Вигерс

Шаблон спецификации требований

1. Введение1.1 Назначение1.2 Соглашения, принятые в документах1.3 Границы проекта1.4 Ссылки2. Общее описание2.1 Общий взгляд на продукт2.2 Классы и характеристики пользователей2.3 Операционная среда2.4 Ограничения дизайна и реализации2.5 Предположения и зависимости3. Функции системы3.x Функция системы X3.x.1 Описание3.x.

2 Функциональные требования4. Требования к данным4.1 Логическая модель данных4.2 Словарь данных4.3 Отчеты4.4 Получение, целостность, хранение и утилизация данных5. Требования к внешним интерфейсам5.1 Пользовательские интерфейсы5.2 Интерфейсы ПО5.3 Интерфейсы оборудования5.4 Коммуникационные интерфейсы6.

Иногда фрагмент информации логически подходит для нескольких разделов шаблона. Выберите один раздел и используйте именно его для информации такого типа в своем проекте. Не дублируйте информацию в нескольких разделах, даже если логически она ложится в эти разделы. Используйте перекрестные ссылки и гиперссылки, чтобы облегчить читателям поиск нужной информации.

1. ВведениеВведение представляет собой обзор, помогающий читателям разобраться в структуре и принципе использования спецификации требований к ПО.

1.1 НазначениеОпределите продукт или приложение, требования для которого указаны в этом документе, в том числе редакцию или номер выпуска. Если эта спецификация требований к ПО относится только к части системы, идентифицируйте эту часть или подсистему. Опишите типы читателей, которым адресован этот документ, например разработчикам, менеджерам проектов, маркетологам, пользователям, тестировщикам или составителям документации.

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

1.3 Границы проектаКратко опишите ПО и его назначение. Покажите, как связан продукт с пользователями или корпоративными целями, а также с бизнес-целями и стратегиями. Если имеется отдельный документ о концепции и границах проекта, не повторяйте его содержимое, а просто сошлитесь на него. Если спецификацию требований к ПО предполагается разрабатывать постепенно, она должна содержать собственное положение о концепции и границах продукта в качестве подраздела долгосрочной стратегической концепции. Можно предоставить высокоуровневую сводку главной функциональности выпуска или функций, которые он должен выполнять.

1.4 СсылкиПеречислите все документы или другие ресурсы, на которые вы ссылаетесь в этой спецификации, в том числе гиперссылки на них, если их местоположение меняться не будет. Это могут быть руководства по стилям пользовательского интерфейса, контракты, стандарты, спецификации к системным требованиям, спецификации интерфейса и спецификации требований к ПО связанных продуктов.

2. Общее описаниеВ этом разделе представлен общий обзор продукта и среды, в которой он будет применяться, предполагаемая пользовательская аудитория, а также известные ограничения, предположения и зависимости.

2.1 Общий взгляд на продуктОпишите контекст и происхождение продукта. Поясните, является он новым членом растущего семейства продуктов, новой версией существующей системы, заменой существующего приложения или совершенно новым продуктом. Если спецификация требований определяет компонент более крупной системы, укажите, как это ПО соотносится со всей системой и определите основные интерфейсы между ними.

2.2 Классы и характеристики пользователейОпределите различные классы пользователей, которые, как предполагается, будут работать с вашим продуктом, и опишите их соответствующие характеристики. Некоторые требования могут относиться только к определенным классам пользователей. Определите привилегированные классы пользователей.

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

Предлагаем ознакомиться:  Отказ страховой компании в выплате по ОСАГО: что делать

2.3 Операционная средаОпишите рабочую среду, в которой будет работать ПО, включая аппаратную платформу, операционные системы и их версии, а также географическое местоположение пользователей, серверов и баз данных вместе с организациями, в которых располагаются соответствующие базы данных, серверы и веб-сайты.

Перечислите все остальные компоненты ПО или приложения, с которыми система должна быть совместима. Если в связи с разработкой новой системы нужно произвести значительную работу с технической инфраструктурой, стоит подумать о создании отдельных требований к инфраструктуре, в которой детально изложить подробности этой работы.

2.4 Ограничения дизайна и реализацииБывает, что нужно использовать вполне определенный язык программирования, определенную библиотеку, на разработку которой уже потрачено время, и т. п. Опишите все факторы, которые ограничат возможности, доступные разработчикам, и логически обоснуйте каждое положение.

Введение

Недавно ко мне обратились, чтобы я посоветовал стандарты для написания технического задания (ТЗ) на разработку автоматизированных систем (АС) и программного обеспечения (ПО). Вот думаю, сейчас зайду в

, найду подходящую статейку и отправлю её. Но не тут-то было! Одной статьи, где перечисляются стандарты для ТЗ, включая шаблоны и примеры готовых документов, я не нашел. Придется сделать такую статейку самому…

• ГОСТ 34• ГОСТ 19• IEEE STD 830-1998• ISO/IEC/ IEEE 29148-2011 • RUP• SWEBOK, BABOK и пр.

ГОСТ 34

регламентирует структуру ТЗ на создание именно СИСТЕМЫ, в которую входят ПО, аппаратное обеспечение, люди, которые работают с ПО, и автоматизируемые процессы.

1. Общие сведения2. Назначение и цели создания (развития) системы3. Характеристика объектов автоматизации4. Требования к системе5. Состав и содержание работ по созданию системы6. Порядок контроля и приемки системы7. Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие8. Требования к документированию9. Источники разработки

При разработке ТЗ для государственных проектов Заказчики, как правило, требуют соблюдение именно этого стандарта.

“ГОСТ 19.ххх Единая система программной документации (ЕСПД)” — это комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ (или ПО) и программной документации. Т.е. этот стандарт относится к разработке именно ПО.

https://www.youtube.com/watch?v=-fApeUIBXhs

Согласно

Предисловие

Цели, основные принципы и основной порядок проведения работ по межгосударственной стандартизации установлены в ГОСТ 1.0-2015 «Межгосударственная система стандартизации. Основные положения» и ГОСТ 1.2-2015 «Межгосударственная система стандартизации. Стандарты межгосударственные, правила и рекомендации по межгосударственной стандартизации. Правила разработки, принятия, обновления и отмены»Сведения о стандарте

1 РАЗРАБОТАН Открытым акционерным обществом «Центр методологии нормирования и стандартизации в строительстве» (ОАО «ЦНС»)

2 ВНЕСЕН Техническим комитетом ТК 465 «Строительство»

Краткое наименование страны
по МК (ИСО 3166) 004-97

Код страны по МК (ИСО 3166) 004-97

Сокращенное наименование национального органа по стандартизации

Азербайджан

AZ

Азстандарт

Армения

AM

Минэкономики Республики Армения

Беларусь

BY

Госстандарт Республики Беларусь

Казахстан

KZ

Госстандарт Республики Казахстан

Киргизия

KG

Кыргызстандарт

Молдова

MD

Молдова-Стандарт

Россия

RU

Росстандарт

Таджикистан

TJ

Таджикстандарт

Узбекистан

UZ

Узстандарт

4 Приказом Федерального агентства по техническому регулированию и метрологии от 17 декабря 2013 г. N 2310-ст межгосударственный стандарт ГОСТ 21.110-2013 введен в действие в качестве национального стандарта Российской Федерации с 1 января 2015 г.

А как же Agile?

Я скажу одной фразой из

: “Working software over comprehensive documentation”. Поэтому в Agile документации отводится совсем мало места.

Мое же убеждение, что разработать АС без ТЗ можно (используя техники/рекомендации Agile), но вот в дальнейшем сопровождать — невозможно. Поэтому сразу задумайтесь, как вы будете писать ТЗ и другую документацию, при разработке ПО по Agile.

Предлагаем ознакомиться:  Удержание отпускных при увольнении: как удержать излишне выплаченную сумму работнику, отгулявшему отпуск авансом, порядок возврата

2 Нормативная ссылка

Образец спецификации на поставку продуктов питания

В настоящем стандарте использована ссылка на следующий межгосударственный стандарт:ГОСТ 21.101-97* Система проектной документации для строительства. Основные требования к проектной и рабочей документации________________* В Российской Федерации действует ГОСТ Р 21.1101-2013. Примечание — При пользовании настоящим стандартом целесообразно проверить действие ссылочных стандартов в информационной системе общего пользования — на официальном сайте Федерального агентства по техническому регулированию и метрологии в сети Интернет или по ежегодному информационному указателю «Национальные стандарты», который опубликован по состоянию на 1 января текущего года, и по выпускам ежемесячного информационного указателя «Национальные стандарты» за текущий год.

Заключение

Как говорится, каждому проекту свое техническое задание. При правильном использовании любого из вышеперечисленных стандартов можно брать эти шаблоны для написания ТЗ, естественно адаптируя их под себя.

Но главное, чтобы ТЗ не превращалось в ХЗ, а, именно, содержание (наполнение) в ТЗ — самое главное! Но это уже совсем другая история… Если есть интерес, то можно пройти он-лайн курс Разработка и управление требованиями к ПО.

Ну а кто дочитал до конца — тому бонус: пример ТЗ, который я писал много лет назад (сейчас уже просто аналитиком давно не работаю, да и другие более удачные примеры запрещает открывать на всеобщее обозрение NDA).

3 Термины и определения

3.1 спецификация оборудования, изделий и материалов: Текстовый проектный документ, определяющий состав оборудования, изделий и материалов и предназначенный для комплектования, подготовки и осуществления строительства.

4 Общие требования

4.1 Спецификацию оборудования, изделий и материалов (далее — спецификация) составляют по форме 1 ко всем основным комплектам рабочих чертежей, кроме основных комплектов рабочих чертежей конструктивных решений (железобетонных, металлических и деревянных конструкций).Если основной комплект рабочих чертежей одной марки разделен на несколько комплектов той же марки, то спецификацию составляют к каждому из этих комплектов.

Допускается модифицировать форму спецификации, например, включать в нее дополнительные графы, изменять размеры граф (кроме размеров граф основной надписи и дополнительных граф к ней), в соответствии с требованиями, установленными в стандартах организаций.Допускается не печатать горизонтальные линии, разграничивающие строки спецификации, при этом необходимо соблюдать интервал не менее одного разряда печати между текстами соседних строк.

4.2 Спецификацию выполняют на бумажном носителе и/или в виде электронного документа.Спецификация в виде электронного документа в содержательной части должна иметь все данные, необходимые для ее вывода на средства отображения информации или на бумажный носитель в соответствии с требованиями настоящего стандарта.

4.3 В спецификацию включают все оборудование, материалы и изделия, предусмотренные рабочими чертежами соответствующего основного комплекта.

Шаблон спецификации требований к ПО - К. Вигерс

4.4 Если в производственном здании (сооружении) предусматриваются пристроенные или встроенные части, в которых размещаются вспомогательные помещения, то спецификацию составляют по частям, например:- производственная часть;- вспомогательная часть.Если в жилом здании предусматриваются пристроенные или встроенные части для размещения предприятий и учреждений общественного назначения, то спецификацию также составляют по частям:- жилая часть;- вспомогательная часть.

4.5 Спецификацию или ее части, как правило, составляют по разделам и, при необходимости, — подразделам. В пределах каждого раздела (подраздела) оборудование, изделия и материалы размещают по группам, а в пределах групп — в порядке возрастания их основных параметров (например, типа, марки, диаметра, сечения, габаритных размеров и т.п.).

Наименования частей, разделов и подразделов записывают в графе «Наименование и техническая характеристика» в виде заголовка, симметричного тексту, и подчеркивают. При этом заголовок раздела и подраздела должен быть отделен от текста интервалом в одну-две строки. Заголовок допускается не подчеркивать.

4.6 В спецификацию не включают отдельные виды изделий и материалы, номенклатуру и количество которых определяет строительно-монтажная организация, исходя из действующих технологических и производственных норм.

Предлагаем ознакомиться:  Договор подряда на буровые работы

4.7 В спецификации указывают:- в графе «Поз.» — позиционные обозначения* оборудования и изделий, предусмотренные рабочими чертежами соответствующего основного комплекта;________________* Позиционное обозначение может быть цифровым или буквенно-цифровым.- в графе «Наименование и техническая характеристика» — наименования оборудования, изделий, материалов, их технические характеристики в соответствии с требованиями стандартов, технических условий и другой технической документации, а также другие необходимые сведения.

При записи материала указывают его условное обозначение, установленное в стандарте или другом нормативном документе. Перед наименованием оборудования, изделий и материалов указывают их порядковый номер записи в спецификацию (как правило, в пределах раздела).В спецификации, выполненной в электронном виде, горизонтальную черту, входящую в обозначение материалов (проката, труб и т.п.

), допускается заменять на косую черту (/):- в графе «Тип, марка, обозначение документа, опросного листа» — тип, марку оборудования, изделия, обозначение стандарта, технических условий или другого документа, а также обозначение опросного листа**, если порядок заказа предусматривает составление опросных листов;

________________** Формы опросных листов устанавливает изготовитель оборудования или изделия.- в графе «Код продукции» — код продукции (оборудования, изделия, материала) по классификатору продукции страны — разработчика рабочей документации***. Если в стандартах, технических условиях, каталогах и др.

— в графе «Поставщик» — наименование (адрес) изготовителя или поставщика оборудования (для импортного оборудования — страну, фирму);- в графе «Ед. измерения» — обозначение единицы измерения;- в графе «Кол.» — количество оборудования, изделий, материалов:- в графе «Масса 1 ед., кг» — массу единицы оборудования, изделия в килограммах.

4.8 В спецификации при записи оборудования и изделий индивидуального изготовления графы «Тип, марка, обозначение документа, опросного листа» и «Код продукции» не заполняют, а в графе «Масса 1 ед.. кг» указывают ориентировочную массу единицы оборудования.

4.9 При применении импортных оборудования, изделий и материалов их записывают с теми наименованиями и обозначениями, которые содержатся в сопроводительной технической документации (документах на поставку).Допускается одновременно указывать аутентичные обозначения и наименования на русском языке.

4.10 Спецификации оборудования, изделий и материалов присваивают обозначение, состоящее из обозначения соответствующего основного комплекта рабочих чертежей по ГОСТ 21.101 и через точку шифра «СО».Пример — 2345-11-ТХ.СО, 2345-11-ОВ.СО, 2345-11-АТХ1.СО

4.11 Первым листом спецификации является титульный лист, выполняемый по форме 15* ГОСТ 21.101 на листе формата А4.________________* Форма 13 ГОСТ Р 21.1101-2013.Листы спецификации оформляют основными надписями:- заглавный** — по форме 5 ГОСТ 21.101;________________** Для текстового документа, выполняемого с титульным листом и оформляемого основными надписями, заглавным является следующий лист после титульного.

4.12 На титульном листе наименование спецификации приводят с указанием наименования соответствующего основного комплекта рабочих чертежей.Примеры

1 Спецификация оборудования, изделий и материалов архитектурных решений.

2 Спецификация оборудования, изделий и материалов наружных сетей водоснабжения и канализации.Наименование документа в основной надписи на заглавном (первом) листе допускается приводить сокращенно: «Спецификация оборудования, изделий и материалов».

4.13 Спецификацию оборудования, изделий и материалов записывают в разделе «Прилагаемые документы» ведомости ссылочных и прилагаемых документов, входящей в общие данные по рабочим чертежам соответствующего основного комплекта.

Форма 1 — Спецификация оборудования, изделий и материалов

УДК 658.516:002:69:006.354

МКС 01.100.30

Ключевые слова: спецификация оборудования, изделий и материалов, правила выполнения, рабочая документация, основной комплект рабочих чертежей, прилагаемые документы

Электронный текст документаподготовлен АО «Кодекс» и сверен по:официальное изданиеМ.: Стандартинформ, 2019

About the Author: admin4ik

You might like

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Adblock detector