В 2004 - 2005 годах был опубликован минимально необходимый набор «учебно-тренировочных» документов на программы, включающий техническое задание на программу по ГОСТ 19.201-78, программу и методику испытаний по ГОСТ 19.301-79, руководство оператора по ГОСТ 19.505-79. Этого достаточно для разработки программы, проведения испытаний и сдачи ее заказчику. Редакция от 23.01.2022.
Создан 15.02.2010 15:50:53
Примечание от 11.06.2014 г. - Уважаемые дамы и господа! Наверное, в каждом втором-третьем из ваших технических заданий на программы, тем или иным образом оказавшихся в руках автора, содержатся аутентичные тексты из настоящей статьи. Это здорово и чертовски приятно, но следует учитывать тот факт, что прошло почти десятилетие с момента первой публикации статьи, а за это время многое изменилось, особенно в части нормативных документов. Из песни, конечно, слов не выкинешь, но настройтесь на креатив и выдумывайте какие-нибудь более современные ее аранжировки. И не забывайте о том, что это учебно-тренировочный, а не «боевой» документ.
Итак,
Техническое задание оформляют в соответствии с ГОСТ 19.106-78 на листах формата 11 и 12 по ГОСТ 2.301-68, как правило, без заполнения полей листа. Номера листов (страниц) проставляются в верхней части листа над текстом [из 1.1 ГОСТ 19.201-78]
Лист утверждения и титульный лист
Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104-78.
Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать [из 1.2 ГОСТ 19.201-78]
Указанной возможностью следует воспользоваться. Меньше слов – меньше вопросов.
Изменения и дополнения
Для внесения изменений или дополнений в техническое задание на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для технического задания [из 1.3 ГОСТ 19.201-78]
Учесть все детали на начальных стадиях разработки невозможно, поэтому на практике указанный подход применяется весьма часто. В разделе «Стадии и этапы разработки» следует явно указать возможность внесения изменений и дополнений в техническое задание: «Содержимое разделов настоящего технического задания может быть изменено и дополнено по согласованию с заказчиком».
Состав разделов технического задания
Техническое задание должно содержать следующие разделы:
- введение (1);
- основания для разработки (2);
- назначение разработки (3);
- требования к программе или программному изделию (4);
- требования к программной документации (5);
- технико-экономические показатели (6);
- стадии и этапы разработки (7);
- порядок контроля и приемки (8);
- в техническое задание допускается включать приложения (9).
В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них [из 1.4 ГОСТ 19.201-78]
Любые манипуляции с разделами - строго по согласованию с заказчиком.
Содержание разделов
Отдельные подразделы технического задания могут подействовать на условного заказчика, как красная тряпка на быка. Заказчика, даже условного, раздражать не следует. В спорных подразделах будут рассмотрены пути поиска компромиссных решений. Ключевые позиции, в которых уступка заказчику равносильна затягиванию петли на шее исполнителя, будут также откомментированы с обоснованием жесткой позиции исполнителя.
Чтобы излишне не отягощать ход повествования, в качестве учебно-тренировочной будем использовать реальную программу с графическим пользовательским интерфейсом, обеспечивающую возможность выполнения нескольких шаблонных функций. Пусть такой программой станет несложный текстовый редактор.
Введение
В разделе «Введение» указывают наименование (1.1), краткую характеристику области применения программы или программного изделия (1.2) и объекта, в котором используют программу или программное изделие (1.3) [из 2.1 ГОСТ 19.201-78]
Основное правило работы с текстом – детализация, дробление текста на структурные единицы, - разделы, подразделы, пункты и подпункты, см. статью «Как писать техническое задание?!» Содержание документа будет иметь четкую структуру, способствующую легкому поиску требуемого материала. Текст документа станет структурированным и удобным для чтения. Создаем подразделы:
Далее: |
Наименование программы
Наименование программы – «Текстовый редактор для работы с файлами формата rtf».
Краткая характеристика области применения
Программа предназначена к применению в профильных подразделениях на объектах заказчика.
Содержимое отдельных пунктов не всегда очевидно. При затруднениях следует подходить формально. Скорректировать документ можно будет в ходе согласования технического задания с заказчиком.
Основания для разработки
В разделе «Основания для разработки» должны быть указаны:
- документ (документы), на основании которых ведется разработка (2.1);
- организация, утвердившая этот документ, и дата его утверждения (2.2);
- наименование и (или) условное обозначение темы разработки (2.3).
[из 2.2 ГОСТ 19.201-78]
В подразделе следует привести сведения, содержащиеся в договоре между заказчиком и исполнителем.
Далее: |
Основание для проведения разработки
Основанием для проведения разработки является Договор (письмо и т.д.) № 666 от 32 мартобря 2004 года (входящий № такой-то от такого-то). Договор утвержден Директором ФГУП «Спецтяжмонтажстройсельхозавтоматика» Ивановым Петром Ивановичем, именуемым в дальнейшем Заказчиком, и утвержден Генеральным директором ОАО «Суперсофт» Блюмкинсом Иваном Ароновичем, именуемым в дальнейшем Исполнителем, такого-то мартобря 2004.
Удобно воспользоваться разделом «Общие сведения» ГОСТ 34.602-89, поскольку разработчик имеет полное право дополнять и удалять разделы технического задания на свое усмотрение. В то же время сведения, указанные выше, содержатся в договоре. Следует ли приводить их в техническом задании – зависит от конкретного случая.
Наименование и условное обозначение темы разработки
Наименование темы разработки – «Разработка текстового редактора для работы с файлами формата rtf». Условное обозначение темы разработки (шифр темы) – «РТФ-007» 😱
Назначение разработки
В разделе «Назначение разработки» должно быть указано функциональное (3.1) и эксплуатационное назначение программы или программного изделия (3.2) [из 2.3 ГОСТ 19.201-78]
Функциональное назначение
Функциональным назначением программы является предоставление пользователю возможности работы с текстовыми документами в формате rtf.
В подразделе должно быть указано «укрупненное» функциональное назначение программы. Детали – перечень функций и т.д. – будут приведены ниже, в соответствующих разделах.
Эксплуатационное назначение может трактоваться достаточно широко. Где, как, кем, с чем должна эксплуатироваться программа?
Резина одного типоразмера может успешно экслуатироваться на Жигулях и Волгах, но не на КаМАЗе. По причине отсутствия размерной технической совместимости. И наоборот. Но для каждого конкретного типоразмера резины можно определить ее эксплуатационное назначение.
Применим формальный подход:
Эксплуатационное назначение
Программа должна эксплуатироваться в профильных подразделениях на объектах заказчика. Пользователями программы должны являться сотрудники профильных подразделений объектов заказчика.
Два крайних предложения - не в тему. При проведении переговоров с реальным заказчиком подраздел будет откорректирован.
Требования к программе или программному изделию
Раздел «Требования к программе или программному изделию» должен содержать следующие подразделы:
- требования к функциональным характеристикам (4.1);
- требования к надежности (4.2);
- условия эксплуатации (4.3);
- требования к составу и параметрам технических средств (4.4);
- требования к информационной и программной совместимости (4.5);
- требования к маркировке и упаковке (4.6);
- требования к транспортированию и хранению (4.7);
- специальные требования (4.8).
[из 2.4 ГОСТ 19.201-78]
Если существуют стандарты, содержащие общие (технические) требования к программе, системе или изделию, к примеру, «ГОСТ 12345-67. Автоматизированные информационно-измерительные системы. Общие (технические) требования», разработка технического задания существенно упрощается. Большая часть содержимого указанного стандарта просто переписывается в техническое задание.
Требования к функциональным характеристикам
В подразделе «Требования к функциональным характеристикам» должны быть указаны требования к составу выполняемых функций (4.1.1), организации входных и выходных данных (4.1.2), временным характеристикам (4.1.3) и т.п. [из 2.4.1 ГОСТ 19.201-78]
Далее: |
Требования к составу выполняемых функций
Программа должна обеспечивать возможность выполнения перечисленных ниже функций:
- функции создания нового (пустого) файла;
- функции открытия (загрузки) существующего файла;
- функции редактирования открытого (далее - текущего) файла путем ввода, замены, удаления содержимого файла с применением стандартных устройств ввода;
- функции редактирования текущего файла с применением буфера обмена операционной системы;
- функции сохранения файла с исходным именем;
- функции сохранения файла с именем, отличным от исходного;
- функции отправки содержимого текущего файла электронной почтой с помощью внешней клиентской почтовой программы;
- функции вывода оперативных справок в строковом формате (подсказок);
- функции интерактивной справочной системы;
- функции отображения названия программы, версии программы, копирайта и комментариев разработчика.
Клише «обеспечивать возможность выполнения» применимо к современным программным средствам, разработанным с использованием графического пользовательского интерфейса. Указанные программные средства большей частью «простаивают» (idle), ожидая действий оператора. Применение клише - шаблонного построения фраз - детально расписано в статье «Как писать техническое задание?!».
Требования к организации входных данных
Входные данные программы должны быть организованы в виде отдельных файлов формата rtf, соответствующих RFC... Файлы указанного формата должны размещаться (храниться) на локальных или съемных носителях, отформатированных согласно требованиям операционной системы.
Любой файл иного формата, но с расширением rtf, открываться не должен.
Файлы http://domain.net/file.rtf или ftp://domain.net/file.rtf открываться не должны. Если файловая система отформатирована как FAT32, файлы с локального или съемного носителя, отформатированного, к примеру, в формате ext3, открываться не должны.
Требования к организации выходных данных
Требования те же, что и к организации выходных данных. Тот самый случай, когда следует объединить оба пункта технического задания.
Требования к временным характеристикам
Требования к временным характеристикам программы не предъявляются.
Следует уточнить, предъявляет ли заказчик требования к быстродействию программы, к примеру, за какое время программа должна стартовать, открывать и закрывать файлы заданного объема. Если заказчик укажет конкретные цифры, следует подстраховаться и заложить в требованиях к составу и параметрам технических средств суперкомпьютер стоимостью от $2500. Правда, такую сумму придется обосновывать. Если временные характеристики для заказчика не принципиальны, следует обязательно написать об отказе от требований к временным характеристикам, см. формулировку выше.
Требования к надежности
В подразделе «Требования к надежности» должны быть указаны требования к обеспечению надежного функционирования (4.2.1) (обеспечения устойчивого функционирования (4.2.2), контроль входной и выходной информации (4.2.3), время восстановления после отказа (4.2.4) и т.п.) [из 2.4.2 ГОСТ 19.201-78]
Надежность – штука тонкая и очень опасная. Но перечень функций и видов их отказов, согласно п. 1.3.2 ГОСТ 24.701-86, обязан составить заказчик и согласовать с исполнителем.
Скорее всего, дождаться от заказчика чего-либо вразумительного не удастся. Стоит разъяснить заказчику, что надежное функционирование программы зависит не столько от исполнителя, сколько от надежности технических средств и операционной системы, а также предложить заказчику ряд жестких мер для повышения надежности и устойчивости функционирования программы.
Далее: |
Требования к обеспечению надежного (устойчивого) функционирования программы
Надежное (устойчивое) функционирование программы должно быть обеспечено выполнением заказчиком совокупности организационно-технических мероприятий, перечень которых приведен ниже:
- организацией бесперебойного питания технических средств;
- использованием лицензионного программного обеспечения;
- регулярным выполнением рекомендаций Министерства труда и социального развития РФ, изложенных в Постановлении от 23 июля 1998 г. «Об утверждении межотраслевых типовых норм времени на работы по сервисному обслуживанию ПЭВМ и оргтехники и сопровождению программных средств»;
- регулярным выполнением требований ГОСТ 51188-98. Защита инфоpмации. Испытания пpогpаммных сpедств на наличие компьютеpных виpусов.
К списку можно добавить еще несколько десятков нормативно-технических документов. В ходе первичного согласования технического задания заказчик, скорее всего, начнет проявлять склонность к компромиссу.
Возможен более гуманный подход. Под надежностью (правда, системы, по тому же ГОСТу) можно считать безотказное выполнение некой i-той функции в течение конкретного интервала времени. Предложим заказчику считать критерием надежной работы программы следующий показатель: заказчик в течение часа 100 раз открывает и закрывает файл. Если в указанном интервале времени программа не даст сбоев, требования по надежности считаются выполненными.
Если заказчик, наконец, убедился, что надежность зависит не столько от исполнителя, сколько от надежности технических средств и операционной системы, и махнул рукой – в разделе обязательно следует написать такую фразу:
Требования к обеспечению надежного (устойчивого) функционирования программы не предъявляются.
Время восстановления после отказа
Время восстановления после отказа, вызванного сбоем электропитания технических средств (иными внешними факторами), не фатальным сбоем (не крахом) операционной системы, не должно превышать стольких-то минут при условии соблюдения условий эксплуатации технических и программных средств. Время восстановления после отказа, вызванного неисправностью технических средств, фатальным сбоем (крахом) операционной системы, не должно превышать времени, требуемого на устранение неисправностей технических средств и переустановки программных средств.
Перечень аварийных ситуаций ситуаций также составляет заказчик и согласовывает с исполнителем. Фактически, это время на перезагрузку операционной системы, если отказ не фатален, не вызван крахом операционной системы или выходом из строя технических средств.
Отказы из-за некорректных действий оператора
Отказы программы возможны вследствие некорректных действий оператора (пользователя) при взаимодействии с операционной системой. Во избежание возникновения отказов программы по указанной выше причине следует обеспечить работу пользователя без предоставления ему административных привилегий.
Условия эксплуатации
В подразделе «Условия эксплуатации» должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики (4.3.1), а также вид обслуживания (4.3.2), необходимое количество и квалификация персонала (4.3.3) [из 2.4.3 ГОСТ 19.201-78]
Очень опасный подраздел для тех, кто делает первые шаги в разработке технического задания.
Далее: |
Климатические условия эксплуатации
Климатические условия эксплутатации, при которых должны обеспечиваться заданные характеристики, должны удовлетворять требованиям, предъявляемым к техническим средствам в части условий их эксплуатации.
Программа будет прекрасно работать от плюс 5 до плюс 35 °C при относительной влажности 90 % и атмосферном давлении 462 мм.рт.ст., поскольку такие условия приблизительно соответствуют условиям эксплуатации современных компьютеров непромышленного исполнения. Но как только в техническом задании окажется конкретика и задание будет утверждено, заказчик получает отличный шанс заставить исполнителя провести климатические испытания в полном объеме за счет исполнителя.
Много лет тому назад автор статьи, в силу молодости и неукротимого желания отстоять свою позицию (в техническом задании, в частности), «попал на климатику», причем «попал конкретно» (так, со слов Путина, выражается просвещенная интеллигенция), на довольно крутом «железе». Автор статьи мигом усвоил, что такое «показать кузькину мать» и «где раки зимуют». Упаси Вас господь «попадать на климатику»!
Примечание от 10.02.2011 г. - По иронии судьбы специалисты «Технической документации» не так давно снова «попали на климатику», а точнее - провели разработку программы и методики испытаний на воздействие внешних факторов, по данным и результатам испытаний подготовили протокол испытаний, открыв для себя еще одно направление деятельности. Не зря говорят, что история развивается по восходящей спирали...
Автор выражает искреннюю благодарность «тогдашнему» заказчику за хороший урок.
Требования к видам обслуживания
Программа не требует проведения каких-либо видов обслуживания.
Виды обслуживания следует позаимствовать из подраздела «Требования к обеспечению надежного (устойчивого) функционирования».
Если заказчик в ходе согласования технического задания сошлется на отсутствие ресурсов или желание проводить все виды обслуживания собственными силами, имеет смысл предложить разработку технического задания на сопровождение программного изделия за отдельные деньги отдельным договором. Откажется – следует считать программу необслуживаемой.
Требования к численности и квалификации персонала
Минимальное количество персонала, требуемого для работы программы, должно составлять не менее 2 штатных единиц – системный администратор и пользователь программы – оператор.
Системный администратор должен иметь высшее профильное образование и сертификаты компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:
- задача поддержания работоспособности технических средств;
- задачи установки (инсталляции) и поддержания работоспособности системных программных средств – операционной системы;
- задача установки (инсталляции) программы.
Пользователь программы (оператор) должен обладать практическими навыками работы с графическим пользовательским интерфейсом операционной системы.
Персонал должен быть аттестован на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).
При отсутствии самой ключевой фразы в утвержденном техническом задании заказчик вправе затребовать от исполнителя разработку руководства по эксплуатации графического пользовательского интерфейса операционной системы, мотивируя тем, что оператор «не справляется» с программой.
Персонал, не имеющий II квалификационной группы по электробезопасности, не имеет права даже близко подходить к ПЭВМ и конторскому оборудованию.
Требования к составу и параметрам технических средств
В подразделе «Требования к составу и параметрам технических средств» указывают необходимый состав технических средств (4.4.1) с указанием их основных технических характеристик (4.4.2) [из 2.4.4 ГОСТ 19.201-78]
Следует подбирать технику не хуже той, на которой будет производиться разработка. Логично затребовать, чтобы технику предоставил заказчик не позднее указанного срока. Речь идет, разумеется, о компьютере.
В состав технических средств должен входить IBM-совместимый персональный компьютер (ПЭВМ), включающий в себя:
- процессор Pentium-1000 с тактовой частотой, ГГц - 10, не менее;
- материнскую плату с FSB, ГГц - 5, не менее;
- оперативную память объемом, Тб - 10, не менее;
- и так далее…
Требования к информационной и программной совместимости
В подразделе «Требования к информационной и программной совместимости» должны быть указаны требования к информационным структурам на входе и выходе (4.5.1) и методам решения (4.5.2), исходным кодам (4.5.3), языкам программирования (4.5.4) и программным средствам, используемым программой (4.5.5).
При необходимости должна обеспечиваться защита информации и программ (4.5.6) [из 2.4.5 ГОСТ 19.201-78]
Требования к информационным структурам и методам решения
Иформационная структура файла должна включать в себя текст, содержащий разметку, предусмотренную спецификацией формата rtf.
или
Требования к информационным структурам (файлов) на входе и выходе, а также к методам решения не предъявляются.
Требования к исходным кодам и языкам программирования
Исходные коды программы должны быть реализованы на языке C++. В качестве интегрированной среды разработки программы должна быть использована среда Borland C++ Buider.
Требования к программным средствам, используемым программой
Системные программные средства, используемые программой, должны быть представлены лицензионной локализованной версией операционной системы такой-то. Допускается применение пакета обновления такого-то.
Требования к защите информации и программ
Требования к защите информации и программ не предъявляются.
Подобных требований следует избегать, если нет особого желания разработать что-то вроде концепции обеспечения информационной безопасности согласно ГТК РФ. Руководящий документ. Защита от несанкционированного доступа к информации. Термины и определения Обеспечить некоторый уровень защиты информации и программ возможно, обеспечить безопасность невозможно. Заказчик, скорее всего, это осознает и проявлять настойчивость не станет.
Требования к маркировке и упаковке
В подразделе «Требования к маркировке и упаковке» в общем случае указывают требования к маркировке программного изделия (4.6.1), варианты и способы упаковки (4.6.2) [из 2.4.6 ГОСТ 19.201-78]
Программа поставляется в виде программного изделия - на дистрибутивном (внешнем оптическом) носителе (компакт-диске). Речь идет, разумеется, о маркировке и упаковке дистрибутивного носителя данных.
Требование к маркировке
Программное изделие должно иметь маркировку с обозначением товарного знака компании-разработчика, типа (наименования), номера версии, порядкового номера, даты изготовления и номера сертификата соответствия Госстандарта России (если таковой имеется). Маркировка должна быть нанесена на программное изделие в виде наклейки, выполненной полиграфическим способом с учетом требований ГОСТ 9181-74.
Качество маркировки проверяется самыми изощренными способами – сначала пытаются смыть маркировку водой, затем бензином и прочими органическими растворителями. Пусть полиграфическое предприятие несет ответственность за некачественную маркировку. Задача исполнителя - прикрыться сертификатом соответствия (затребовать сертификат у полиграфистов).
Требования к упаковке
Упаковка программного изделия должна осуществляться в упаковочную тару предприятия-изготовителя (поставщика).
Именно предприятия-изготовителя (поставщика). Исполнитель не может и не должен нести ответственность большую, чем предприятие-изготовитель (поставщик) тары.
Условия упаковывания
Упаковка программного изделия должна проводиться в закрытых вентилируемых помещениях при температуре от плюс 15 до плюс 40 °С и относительной влажности не более 80 % при отсутствии агрессивных примесей в окружающей среде.
Заказчик получит программное изделие надлежащего внешнего вида. В случае возврата программного изделия (по рекламации) в ненадлежащем виде (наличие царапин, трещин и прочих дефектов) исполнитель сможет предъявить претензии в части нарушения заказчиком условий упаковывания и не принять программное изделие.
Порядок упаковки
Подготовленные к упаковке программные изделия укладывают в тару, представляющую собой коробки из картона гофрированного (ГОСТ 7376-89 или ГОСТ 7933- 89) согласно чертежам предприятия-изготовителя тары.
Программное изделие упаковывается с применением чехлов из водонепроницаемой пленки с обязательным наличием химически неагрессивных влагопоглотителей (силикагеля).
Для заполнения свободного пространства в упаковочную тару укладываются прокладки из гофрированного картона или пенопласта.
Эксплуатационная документация должна быть уложены в потребительскую тару вместе с программным изделием.
На верхний слой прокладочного материала укладывается товаросопроводительная документация - упаковочный лист и ведомость упаковки.
Потребительская тара должна быть оклеена лентой клеевой 6-70 по ГОСТ 18251-87.
Упакованные в потребительскую тару программные изделия должны быть уложены на поддон, стянуты лентой для предотвращения потери формы груза и упакованы в полиэтиленовую пленку М 0,2 для защиты от попадания влаги.
В коробку поддона должна быть вложена товаросопроводительная документация, в том числе упаковочный лист согласно ГОСТ 25565-88.
Габариты грузового места должны быть не более 1250 • 820 • 1180 мм.
Масса НЕТТО - не более 200 кг.
Масса БРУТТО - не более 220 кг.
Приведен порядок упаковки из ранее разработанного документа на какие-то технические средства. Выглядит несколько необычно в контексте программного изделия. Говоря простым русским языком - полнейший стёб, но требования есть и остаются требованиями.
Требования к транспортированию и хранению
В подразделе «Требования к транспортированию и хранению» должны быть указаны для программного изделия условия транспортирования (4.7.1), места хранения (4.7.2), условия хранения (4.7.3), условия складирования (4.7.4), сроки хранения в различных условиях (4.7.5) [из 2.4.7 ГОСТ 19.201-78]
В подразделе приведены условия транспортирования и хранения из ранее разработанного документа на какие-то технические средства. Это касается и требований к порядку упаковки. Выглядит несколько необычно в контексте программного изделия.
Заказчик не вправе нарушать условий транспортирования и хранения. Исполнитель сможет отказать заказчику в возврате программного изделия, утверждая, что ненадлежащий внешний вид программного изделия является следствием несоблюдения условий транспортирования и хранения.
Условия транспортирования и хранения
Допускается транспортирование программного изделия в транспортной таре всеми видами транспорта (в том числе в отапливаемых герметизированных отсеках самолетов без ограничения расстояний). При перевозке в железнодорожных вагонах вид отправки - мелкий малотоннажный.
При транспортировании и хранении программного изделия должна быть предусмотрена защита от попадания пыли и атмосферных осадков. Не допускается кантование программного изделия. Климатические условия транспортирование приведены ниже:
- температура окружающего воздуха, °С - от плюс 5 до плюс 50;
- атмосферное давление, кПа - такое-то;
- относительная влажность воздуха при 25 °С - такая-то.
Специальные требования
Программа должна обеспечивать взаимодействие с пользователем (оператором) посредством графического пользовательского интерфейса, разработанного согласно рекомендациям компании-производителя операционной системы.
Разработчики настоящего стандарта смотрели в будущее. Не существовало в те годы программ с графическим пользовательским интерфейсом.
Требования к программной документации
В разделе «Требования к программной документации» должен быть указан предварительный состав программной документации (5.1) и, при необходимости, специальные требования к ней (5.2) [из 2.5а ГОСТ 19.201-78]
Предварительный состав программной документации
В состав программной документации должны входить:
- техническое задание;
- программа и методика испытаний;
- руководство системного программиста;
- руководство оператора;
- ведомость эксплуатационных документов.
Программа и методика испытаний потребуется, чтобы показать заказчику, что разработанная исполнителем программа соответствует требованиям согласованного и утвержденного технического задания. После проведения совместных (приемо-сдаточных) испытаний заказчик и исполнитель подпишут акт завершения работы. И, тем самым, работа будет закрыта, условия договора выполнены.
Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ [из 2.6 ГОСТ 19.101-77]
Но тем, кто впервые занялся разработкой программной документации, лучше придерживаться принципа «мухи отдельно, котлеты отдельно».
Технико-экономические показатели
В разделе «Технико-экономические показатели» должны быть указаны: ориентировочная экономическая эффективность (6.1), предполагаемая годовая потребность (6.2), экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами (6.3) [из 2.5 ГОСТ 19.201-78]
Ориентировочная экономическая эффективность не рассчитываются. Предполагаемое число использования программы в год – 365 сеансов работы на одном рабочем месте.
Как рассчитать экономическую эффективность? Следовало бы получить от заказчика цифры. Заказчик, в свою очередь, вряд ли заинтересован раскрывать свои финансовые дела. Скорее всего, вопрос отпадет сам собой.
Положим, заказчик оснащает программой десяток рабочих мест. Исполнитель потребовал за разработку $1000. Заказчик мог бы установить на рабочие места программный продукт третьей фирмы, стоимостью $500 за дистрибутив и по $100 за лицензию на каждое рабочее место.
Экономические преимущества разработки
Экономические преимущества разработки в сравнении с лучшими отечественными и зарубежными аналогами составит:
число рабочих мест | аналоги | разработка | экономические преимущества |
10 | $1500 | $1000 | $500 |
100 | $11500 | $1000 | $10500 |
и так далее… | ... | ... | ... |
Стадии и этапы разработки
В разделе «Стадии и этапы разработки» устанавливают необходимые стадии разработки (7.1), этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены) (7.2), а также, как правило, сроки разработки и определяют исполнителей (7.3) [из 2.6 ГОСТ 19.201-78]
Стадии разработки и этапы регламентированы ГОСТ 19.102-77. ГОСТ 19.102-77 не препятствует исключению отдельных стадий работ, а также объединению отдельных этапов работ.
Далее: |
Стадии разработки
Разработка должна быть проведена в три стадии:
- техническое задание;
- технический (и рабочий) проекты;
- внедрение.
Этапы разработки
На стадии «Техническое задание» должен быть выполнен этап разработки, согласования и утверждения настоящего технического задания.
На стадии «Технический (и рабочий) проект» должны быть выполнены перечисленные ниже этапы работ:
- разработка программы;
- разработка программной документации;
- испытания программы.
На стадии «Внедрение» должен быть выполнен этап разработки «Подготовка и передача программы».
Содержание работ по этапам
На этапе разработки техзадания должны быть выполнены перечисленные ниже работы:
- постановка задачи;
- определение и уточнение требований к техническим средствам;
- определение требований к программе;
- определение стадий, этапов и сроков разработки программы и документации на нее;
- выбор языков программирования;
- согласование и утверждение технического задания.
На этапе разработки программы должна быть выполнена работа по программированию (кодированию) и отладке программы.
На этапе разработки программной документации должна быть выполнена разработка программных документов в соответствии с требованиями ГОСТ 19.101-77.
На этапе испытаний программы должны быть выполнены перечисленные ниже виды работ:
- разработка, согласование и утверждение программы (в ГОСТ, похоже, опечатка – «порядка») и методики испытаний;
- проведение приемо-сдаточных испытаний;
- корректировка программы и программной документации по результатам испытаний.
На этапе подготовки и передачи программы должна быть выполнена работа по подготовке и передаче программы и программной документации в эксплуатацию на объектах заказчика.
Порядок контроля и приемки
В разделе «Порядок контроля и приемки» должны быть указаны виды испытаний (8.1) и общие требования к приемке работы (8.2) [из 2.7 ГОСТ 19.201-78]
Виды испытаний
Приемосдаточные испытания должны проводиться на объекте заказчика в сроки…
Приемосдаточные испытания программы должны проводиться согласно разработанной (не позднее такого-то срока) исполнителем и согласованной заказчиком «Программы и методики испытаний».
Ход проведения приемо-сдаточных испытаний заказчик и исполнитель документируют в протоколе испытаний.
Общие требования к приемке работы
На основании протокола испытаний исполнитель совместно с заказчиком подписывают акт приемки-сдачи программы в эксплуатацию.
Приложения
В приложениях к техническому заданию, при необходимости, приводят:
- перечень научно-исследовательских и других работ, обосновывающих разработку (9.1);
- схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке (9.2);
- другие источники разработки (9.3).
[из 2.8 ГОСТ 19.201-78]
Если есть, почему не привести. И обязательно выложить перечень ГОСТов, на основании которых должна проводиться разработка. Например:
- ГОСТ 19.201-78. Техническое задание, требования к содержанию и оформлению;
- и так далее..
Выводы
Настоящий стандарт, несмотря на свой немалый возраст, позволяет разработать полноценное техническое задание на современную программу с графическим пользовательским интерфейсом. Разработчики ГОСТ 19.201-78 смотрели в будущее и учли практически все аспекты, касающиеся разработки программных средств.
Что осталось неучтенным? Сроки, объемы и этапы финансирования? Техническое задание всегда разрабатывается на основании Договора, письма, заявки и т.д. Указанные сведения должны быть отражены в Договоре.
Каковы спорные моменты? Отсутствие в стандарте конктретных требований, положим, к пользовательскому интерфейсу? Разработчиками стандарта предусмотрен раздел «Специальные требования», возможность добавления новых разделов, допустим, разделов «Дополнительные требования» или «Требования к интерфейсу».