2.1.2. Содержание разделов
В разделе Наименование и область применения указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.
ПРИМЕР СОДЕРЖАНИЯ:
Полное наименование системы: Автоматизированная система учета компьютерного оборудования".
Краткое наименование системы: АС «Учет компьютерного оборудования».
В разделе Основание для разработки должны быть указаны:
документ (документы), на основании которых ведется разработка;
ПРИМЕР СОДЕРЖАНИЯ (берется из ТЗ на АС в целом):
Основанием для разработки АС являются следующие документы и нормативные акты:
– Государственный контракт №1/11-11-11-001 от 11.11.2007 года на выполнение работ по выполнению первого этапа работ по созданию Автоматизированной системы учета компьютерного оборудования;
– Федеральный закон от 01 июля 2006 г. N 555-ФЗ «Управление компьютерным оборудованием».
– Постановление Правительства РФ от 01 января 2000 г. N 11.11 «О федеральной целевой программе "Электронная компьютерная оргтехника (2002 - 2009 годы)»;
– Концепция информатизации федерального агентства "Учет компьютерного оборудования" на 2000-2010 годы.
организация, утвердившая этот документ, и дата его утверждения;
ПРИМЕР СОДЕРЖАНИЯ:
Организация, утвердившая документ: Комитет по информационным ресурсам Администрации Губернатора Ханты-Мансийского автономного округа – Югры.
Адрес организации: Ханты-Мансийского автономный округ – Югры, Организационная, д.1
Дата утверждения документа: 07.07.2007
наименование и (или) условное обозначение темы разработки.
ПРИМЕР СОДЕРЖАНИЯ:
Шифр темы: АИС-КО-ФА-07
N |
Сокращение |
Расшифровка |
1 |
ФА |
Федеральное агентство |
2 |
ТЗ |
Техническое задание |
3 |
АИС |
Автоматизированная информационная система |
Применительно к специфике учебного процесса основанием может служить задание на курсовое проектирование, приказ по институту от __.__. за N ___., договор __.__. за N ___., и т.п.
В разделе Назначение разработки должно быть указано функциональное и эксплуатационное назначение программы или программного изделия. Ограничиться здесь можно одной-двумя фразами. Главное – четко определить, для чего нужна эта программа.
ПРИМЕР СОДЕРЖАНИЯ:
Автоматизированная система Открытый ведомственный информационный ресурс (АС ОВИР) предназначена для обеспечения публичного доступа гражданам Российской Федерации к открытой части информации АС «Учет компьютерного оборудования» через Интернет. Также АС ОВИР должна обеспечивать доступ пользователей АС «Учета компьютерного оборудовании»я к операционным данным БД АС (путем предоставления сервисов, позволяющих формировать запросы на получение информации ограниченного доступа, в соответствии с уровнем компетентности пользователя).
Его функциями являются:
1) Предоставление публичного доступа к следующей информации:
- Новости;
- Статистические данные и отчеты;
- Полный перечень документов, регламентирующих работу ФА и услуги, предоставляемые им;
- т.п.;
- пр.
2) Обеспечение возможности сотрудникам ФА получать доступ к служебной информации АС «Учета компьютерного оборудования»;
3) Обеспечение функций администрирования;
т.п.;
пр.
Раздел Технические требования к программе или программному изделию должен содержать следующие подразделы:
требования к функциональным характеристикам;
требования к надежности;
условия эксплуатации;
требования к составу и параметрам технических средств;
требования к информационной и программной совместимости;
требования к маркировке и упаковке;
требования к транспортированию и хранению;
специальные требования.
Иными словами, здесь начинается конкретика. Описывается то, что должна делать программа и как она должна выглядеть.
Требования к функциональным характеристикам. Здесь должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т.п.
ПРИМЕР СОДЕРЖАНИЯ:
АС ОВИР должна выполнять следующие функции:
1. Функции для работы с гражданами:
- Обеспечение доступа всех пользователей к общедоступным функциям и сведениям, опубликованным на сайте;
- Отображение сведений о федеральном агентстве;
- Отображение новостных, нормативно-правовых и других сведений в графическом виде, табличной и текстовой форме;
- Навигация по разделам сайта;
- Поиск по ключевым словам;
- Скачивание на компьютер пользователя и печать бланков документов, представляемых в федеральное агентство;
- Регистрация пользователей;
- Управление профилем.
2. Административные функции:
- т.п.;
- пр.
Точный состав сведений, размещаемых на сайте, и функций сайта будет определен и согласован с Заказчиком на этапе подготовки технического задания на разработку АС ОВИР.
Требования к надежности. Должны быть указаны требования к обеспечению надежного функционирования (обеспечение устойчивого функционирования, контроль входной и выходной информации, время восстановления после отказа и т.п.).
Здесь "выгадать" что-то сложно. В лучшем случае может пройти вариант, при котором ваша программа работает только с абсолютно корректными данными. Обычно Заказчик на это не идет, но попробовать можно.
ПРИМЕР ФОРМАЛЬНОГО СОДЕРЖАНИЯ:
Система должна сохранять работоспособность и обеспечивать восстановление своих функций при возникновении следующих внештатных ситуаций:
– при сбоях в системе электроснабжения аппаратной части, приводящих к перезагрузке ОС, восстановление программы должно происходить после перезапуска ОС и запуска исполняемого файла системы;
– при ошибках в работе аппаратных средств (кроме носителей данных и программ) восстановление функции системы возлагается на ОС;
– при ошибках, связанных с программным обеспечением (ОС и драйверы устройств), восстановление работоспособности возлагается на ОС.
Для защиты аппаратуры от бросков напряжения и коммутационных помех должны применяться сетевые фильтры.
Условия эксплуатации. Должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
ПРИМЕР СОДЕРЖАНИЯ:
Система должна быть рассчитана на эксплуатацию в составе программно–технического комплекса Заказчика и учитывать разделение ИТ инфраструктуры Заказчика на внутреннюю и внешнюю.
Для нормальной эксплуатации разрабатываемой системы должно быть обеспечено бесперебойное питание ПЭВМ. При эксплуатации система должна быть обеспечена соответствующая стандартам хранения носителей и эксплуатации ПЭВМ температура и влажность воздуха.
Периодическое техническое обслуживание используемых технических средств должно проводиться в соответствии с требованиями технической документации изготовителей, но не реже одного раза в год.
Периодическое техническое обслуживание и тестирование технических средств должны включать в себя обслуживание и тестирование всех используемых средств, включая рабочие станции, серверы, кабельные системы и сетевое оборудование, устройства бесперебойного питания.
В процессе проведения периодического технического обслуживания должны проводиться внешний и внутренний осмотр и чистка технических средств, проверка контактных соединений, проверка параметров настроек работоспособности технических средств и тестирование их взаимодействия.
На основании результатов тестирования технических средств должны проводиться анализ причин возникновения обнаруженных дефектов и приниматься меры по их ликвидации.
Восстановление работоспособности технических средств должно проводиться в соответствии с инструкциями разработчика и поставщика технических средств и документами по восстановлению работоспособности технических средств и завершаться проведением их тестирования. При вводе системы в опытную эксплуатацию должен быть разработан план выполнения резервного копирования программного обеспечения и обрабатываемой информации. Во время эксплуатации системы, персонал, ответственный за эксплуатацию системы должен выполнять разработанный план.
Размещение помещений и их оборудование должны исключать возможность бесконтрольного проникновения в них посторонних лиц и обеспечивать сохранность находящихся в этих помещениях конфиденциальных документов и технических средств.
Размещение оборудования, технических средств должно соответствовать требованиям техники безопасности, санитарным нормам и требованиям пожарной безопасности.
Все пользователи системы должны соблюдать правила эксплуатации электронной вычислительной техники.
Квалификация персонала и его подготовка должны соответствовать технической документации.
Требования к составу и параметрам технических средств. Указывают необходимый состав технических средств с указанием их технических характеристик.
ПРИМЕР СОДЕРЖАНИЯ:
Техническое обеспечение системы должно максимально и наиболее эффективным образом использовать существующие в органах федерального агентства технические средства.
В состав комплекса (Рисунок 1) должны следующие технические средства:
– Серверы БД;
– Серверы приложений;
– Сервер системы формирования отчетности;
– Веб сервер;
– ПК пользователей;
– ПК администраторов.
Серверы БД должны быть объединены в отказоустойчивый кластер. Серверы приложений должны образовывать кластер с балансировкой нагрузки.
Серверы БД, серверы приложений и сервер системы формирования отчетности должны быть объединены одной локальной сетью, с пропускной способностью не менее 100 Мбит.
Требования к техническим характеристикам серверов БД:
– Процессор – 2 х Intel Xeon 3 ГГц;
– Объем оперативной памяти – 16 Гб;
– Дисковая подсистема – 4 х 146 Гб;
– Устройство чтения компакт-дисков (DVD-ROM);
– Сетевой адаптер – 100 Мбит.
Требования к техническим характеристикам системы хранения данных:
– Дисковая подсистема 0,5 Тб Raid Array 5
Требования к техническим характеристикам серверов приложений:
– Процессор – 2 х Intel Xeon 3 ГГц;
– Объем оперативной памяти – 8 Гб;
– Дисковая подсистема – 4 х 146 Гб;
– Устройство чтения компакт-дисков (DVD-ROM);
– Сетевой адаптер – 100 Мбит.
Требования к техническим характеристикам веб сервера:
– Процессор – 2 х Intel Xeon 3 ГГц;
– Объем оперативной памяти – 16 Гб;
– Дисковая подсистема – 4 х 146 Гб;
– Устройство чтения компакт-дисков (DVD-ROM);
– Сетевой адаптер – 100 Мбит.
Требования к техническим характеристикам ПК пользователя и ПК администратора:
– Процессор – Intel Pentium 1.5 ГГц;
– Объем оперативной памяти – 256 Мб;
– Дисковая подсистема – 40 Гб;
– Устройство чтения компакт-дисков (DVD-ROM);
– Сетевой адаптер – 100 Мбит.
Требования к информационной и программной совместимости. Особенности те же, что и в предыдущем пункте. Здесь должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования. При необходимости должна обеспечиваться защита информации и программ.
ПРИМЕР СОДЕРЖАНИЯ:
Входящие в состав АС «Учет компьютерного оборудования» подсистемы в процессе функционирования должны обмениваться информацией на основе открытых форматов обмена данными, используя для этого входящие в их состав модули информационного взаимодействия.
Форматы данных будут разработаны и утверждены на этапе технического проектирования.
В состав передаваемых данных входят:
- Данные НСИ;
- Сведения о государственных предприятиях;
- Сведения о персонале;
- ...и т.д.
АС «Учета компьютерного оборудования» должна взаимодействовать следующими смежными системами:
- Смежная система 1;
- Смежная система 2.
Возможны следующие варианты обмена (АС Кадры и Смежная система 1):
- Экспорт нормативно-справочной информации;
- Экспорт выписок штатных расписаний;
- Импорт нормативно-справочной информации;
- т.д.
Результаты выполнения операций импорта и экспорта данных должны регистрироваться в специальном журнале событий и предоставляться по запросу пользователя.
Требования к маркировке и упаковке и требования к транспортированию и хранению являются достаточно экзотическими. В общем случае здесь указывают требования к маркировке программного изделия, варианты и способы упаковки. А в требованиях к транспортированию и хранению должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.
ПРИМЕР СОДЕРЖАНИЯ:
Требования не предъявляются.
Специальные требования – это весьма ответственная вещь. Их лучше, по возможности, всячески избегать. И заявить об этом сразу.
Например: Специальных требований к временным характеристикам программы не предъявляется. Специальных требований к емкостным характеристикам программы не предъявляется.
Технико-экономические показатели. Этот самый сложный для программиста пункт есть далеко не всегда. Он нужен, прежде всего, тогда, когда вашей целью является обоснование огромной эффективности и важности выполняемой работы. На Заказчика этот пункт действует, обычно, очень хорошо. По крайне мере, это лучшее обоснование сроков и денежных сумм разработки.
В этом разделе должны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
Помимо этого, желательно привести определение, как сметной стоимости разработки программы, так и определение трудоемкости программирования.
ПРИМЕР СОДЕРЖАНИЯ:
Ориентировочная экономическая эффективность не рассчитываются.
Предполагаемая годовая потребность продукта - 100 сеансов в год.
Зарубежных и отечественных аналогов нет.
Стадии и этапы разработки устанавливают необходимые стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и определяют исполнителей.
Основными и непременными стадиями и этапами являются само техническое задание, эскизный проект, технический и рабочий проекты.
Эскизный проект. На этой стадии детально разрабатываются структуры входных и выходных данных, определяется форма их представления. Разрабатывается общее описание алгоритма, сам алгоритм, структура программы. Разрабатываются план мероприятий по разработке и внедрению программы.
Технический проект. Содержит разработанный алгоритм решения задачи, а также методы контроля исходной информации. Здесь же разрабатываются средства обработки ошибок и выдачи диагностических сообщений, определяются формы представления исходных данных и конфигурация технических средств.
Рабочий проект. На этой стадии осуществляется программирование и отладка программы, разработка программных документов, программы и методики испытаний. Подготавливаются контрольно-отладочные примеры. Окончательно оформляются документация и графический материал. Обычно указывается, что в ходе разработки программы должна быть подготовлена следующая документация:
текст программы;
описание программы;
программа и методика испытаний;
описание применения;
руководство пользователя.
Например: В ходе разработки программы должен быть подготовлен следующий графический материал:
технико-экономические показатели;
структура программы;
формат представления входных данных программы;
общая схема алгоритма (2 листа);
основные вычислительные алгоритмы;
пример работы программы.
ПРИМЕР СОДЕРЖАНИЯ:
В ходе выполнения проекта на объекте автоматизации требуется выполнить работы по подготовке к вводу системы в действие. При подготовке к вводу в эксплуатацию АС «Учета компьютерного оборудования» Заказчик должен обеспечить выполнение следующих работ:
- Определить подразделение и ответственных должностных лиц, ответственных за внедрение и проведение опытной эксплуатации АС «Учета компьютерного оборудования»;
- Обеспечить присутствие пользователей на обучении работе с системой, проводимом Исполнителем;
- Обеспечить соответствие помещений и рабочих мест пользователей системы в соответствии с требованиями, изложенными в настоящем ЧТЗ;
- Обеспечить выполнение требований, предъявляемых к программно-техническим средствам, на которых должно быть развернуто программное обеспечение АС «Учета компьютерного оборудования»;
- Совместно с Исполнителем подготовить план развертывания системы на технических средствах Заказчика;
- Провести опытную эксплуатацию АС «Учета компьютерного оборудования».
Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие, включая перечень основных мероприятий и их исполнителей должны быть уточнены на стадии подготовки рабочей документации и по результатам опытной эксплуатации.
В разделе Порядок контроля и приемки должны быть указаны виды испытаний и общие требования к приемке работы.
ПРИМЕР СОДЕРЖАНИЯ:
Виды, состав, объем, и методы испытаний подсистемы должны быть изложены в программе и методике испытаний АС «Учета компьютерного оборудования», разрабатываемой в составе рабочей документации.
Сдача-приёмка работ производится поэтапно, в соответствии с рабочей программой и календарным планом, являющимися приложениями к Госконтракту №... от ... года.
Сдача-приемка осуществляется комиссией, в состав которой входят представители Заказчика и Исполнителя. По результатам приемки подписывается акт приемочной комиссии.
Все создаваемые в рамках настоящей работы программные изделия (за исключением покупных) передаются Заказчику, как в виде готовых модулей, так и в виде исходных кодов, представляемых в электронной форме на стандартном машинном носителе (например, на компакт-диске).
В Приложениях к техническому заданию, при необходимости, приводят:
перечень научно-исследовательских и других работ, обосновывающих разработку;
схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
другие источники разработки.
ПРИМЕР СОДЕРЖАНИЯ:
Требования не предъявляются.