ТехЗадание_образец1. Методические указания к лабораторной работе 1 Разработка технического задания на программное средство и автоматизированную систему
 Скачать 0.78 Mb.
|
|
Специальные требования Программа должна обеспечивать взаимодействие с пользователем ( оператором ) посредством графического пользовательского интерфейса , разработанного согласно рекомендациям компании-производителя операционной системы. Разработчики настоящего стандарта смотрели в будущее. Не существовало в те годы программ с графическим пользовательским интерфейсом. Требования к программной документации В разделе «Требования к программной документации» должен быть указан предварительный состав программной документации и, при необходимости, специальные требования к ней [из п. 2.5а ГОСТ 19.201-78] Предварительный состав программной документации В состав программной документации должны входить: техническое задание ; программа и методика испытаний ; руководство системного программиста ; руководство оператора ; ведомость эксплуатационных документов Программа и методика испытаний потребуется, чтобы показать заказчику, что разработанная исполнителем программа соответствует требованиям согласованного и утвержденного технического задания. После проведения совместных (приемо-сдаточных) испытаний заказчик и исполнитель подпишут акт завершения работы . И, тем самым, работа будет закрыта, условия договора выполнены. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра ). Необходимость объединения этих документов указывается в техническом задании . Объединенному документу присваивают наименование и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ [из п. 2.6 ГОСТ 19.101-77] Но тем, кто впервые занялся разработкой программной документации, лучше придерживаться принципа «мухи отдельно, котлеты отдельно». Технико-экономические показатели В разделе «Технико-экономические показатели» должны быть указаны: ориентировочная экономическая эффективность , предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами [из п. 2.5 ГОСТ 19.201-78] Ориентировочная экономическая эффективность не рассчитываются. Предполагаемое число использования программы в год – 365 сеансов работы на одном рабочем месте. Как рассчитать экономическую эффективность? Следовало бы получить от заказчика цифры. Заказчик, в свою очередь, вряд ли заинтересован раскрывать свои финансовые дела. Скорее всего, вопрос отпадет сам собой. Положим, заказчик оснащает программой десяток рабочих мест. Исполнитель потребовал за разработку $1000. Заказчик мог бы установить на рабочие места программный продукт третьей фирмы, стоимостью $500 за дистрибутив и по $100 за лицензию на каждое рабочее место. Экономические преимущества разработки Экономические преимущества разработки в сравнении с лучшими отечественными и зарубежными аналогами составит: число рабочих мест аналоги разработка экономические преимущества 10 $1500 $1000 $500 100 $11500 $1000 $10500 и так далее… Стадии и этапы разработки В разделе «Стадии и этапы разработки» устанавливают необходимые стадии разработки , этапы и содержание работ (перечень программных документов , которые должны быть разработаны, согласованы и утверждены ), а также, как правило, сроки разработки и определяют исполнителей [из п. 2.6 ГОСТ 19.201-78] Стадии разработки и этапы регламентированы ГОСТ 19.102-77 . ГОСТ 19.102-77 не препятствует исключению отдельных стадий работ, а также объединению отдельных этапов работ. Стадии разработки Разработка должна быть проведена в три стадии: техническое задание; технический (и рабочий) проекты; внедрение. Этапы разработки На стадии «Техническое задание» должен быть выполнен этап разработки, согласования и утверждения настоящего технического задания. На стадии «Технический (и рабочий) проект» должны быть выполнены перечисленные ниже этапы работ: разработка программы; разработка программной документации; испытания программы. На стадии «Внедрение» должен быть выполнен этап разработки «Подготовка и передача программы». Содержание работ по этапам На этапе разработки техзадания должны быть выполнены перечисленные ниже работы: постановка задачи; определение и уточнение требований к техническим средствам; определение требований к программе; определение стадий, этапов и сроков разработки программы и документации на нее; выбор языков программирования; согласование и утверждение технического задания. На этапе разработки программы должна быть выполнена работа по программированию (кодированию) и отладке программы На этапе разработки программной документации должна быть выполнена разработка программных документов в соответствии с требованиями ГОСТ 19.101-77. На этапе испытаний программы должны быть выполнены перечисленные ниже виды работ: разработка, согласование и утверждение программы (в ГОСТ, похоже, опечатка – «порядка») и методики испытаний; проведение приемо-сдаточных испытаний; корректировка программы и программной документации по результатам испытаний. На этапе подготовки и передачи программы должна быть выполнена работа по подготовке и передаче программы и программной документации в эксплуатацию на объектах заказчика. Перечень программных документов, которые должны быть разработаны 1. Описание архитектуры программы 2. Описание программы и исходный код 3. Руководство пользователя 4. Справочная документация Сроки и исполнители разработки № Этапы работ Описание этапов Фамилии исполнителей Срок исполнения 1 Постановка задачи Определение компонентов системы их взаимодействие, назначение и т.п. Иванов И.И. – ответствен. исп. Петров П.П. - соисполнитель 01.01.2018-01.02. 2018 (1 мес.) 2 Разработка интерфейса пользователя Создания прототипа интерфейса пользователя Иванова И.И. – ответствен. исп. Петрова П.П. - соисполнитель 10.01.2018-10.02. 2018 (1 мес.) 3 Разработка программного кода (1 эпап) Написание основных классов и интерфейсов Иванов И.И. – ответствен. исп. Петров П.П. - соисполнитель 01.02.2018-01.05. 2018 (3 мес.) 4 И т.д. Порядок контроля и приемки В разделе «Порядок контроля и приемки» должны быть указаны виды испытаний и общие требования к приемке работы [из п. 2.7 ГОСТ 19.201-78] Виды испытаний Приемосдаточные испытания должны проводиться на объекте заказчика в сроки… Приемосдаточные испытания программы должны проводиться согласно разработанной (не позднее такого-то срока) исполнителем и согласованной заказчиком «Программы и методики испытаний». Ход проведения приемо-сдаточных испытаний заказчик и исполнитель документируют в протоколе испытаний Общие требования к приемке работы На основании протокола испытаний исполнитель совместно с заказчиком подписывают акт приемки-сдачи программы в эксплуатацию. Приложения В приложениях к техническому заданию, при необходимости, приводят: перечень научно-исследовательских и других работ, обосновывающих разработку; схемы алгоритмов , таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке; другие источники разработки. обязательно выложить перечень ГОСТов, на основании которых должна проводиться разработка. Например: ГОСТ 19.201-78. Техническое задание, требования к содержанию и оформлению; и так далее. Состав ТЗ на АС Согласно п. 2.1 ГОСТ 34.602-89 ТЗ на АС содержит следующие разделы, которые могут быть разделены на подразделы: общие сведения; назначение и цели создания (развития) системы; характеристика объектов автоматизации; требования к системе; состав и содержание работ по созданию системы; порядок контроля и приемки системы; требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие; требования к документированию; источники разработки. В ТЗ на АС могут включаться приложения. Правила оформления текстовой части ТЗ по ГОСТ 2.105-95 Согласно п. 3.1 ГОСТ 2.105-95 текстовые документы подразделяют на документы, содержащие, в основном, сплошной текст (технические условия, паспорта, расчеты, пояснительные записки, инструкции и т.п.), и документы, содержащие текст, разбитый на графы (спецификации, ведомости, таблицы и т.п.). Текстовые документы выполняют в бумажной форме и (или) в форме электронного документа. Допускается в текстовых документах, содержащих текст, разбитый на графы, использовать сокращения слов по ГОСТ 2.316-2008 «ЕСКД. Правила нанесения надписей, технических требований и таблиц на графических документах. Общие положения». Требования к текстовым документам, содержащим в основном сплошной текст, подробно изложены в четвертом разделе ГОСТ 2.105-95. Рассмотрим основные положения этого раздела. Построение документа В п. 4.1 ГОСТ 2.105-95 приведены подробные инструкции по нумерации и расположению разделов, подразделов, пунктов и подпунктов. Разделы должны иметь порядковые номера в пределах всего документа, обозначенные арабскими цифрами без точки и записанные с абзацного отступа. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела точка не ставится. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов. При наличии подразделов нумерация пунктов должна быть в пределах подраздела и номер пункта должен состоять из номеров раздела, подраздела и пункта, разделенных точками. При отсутствии подразделов нумерация пунктов производится в пределах каждого раздела. В конце номера пункта точка не ставится. Если раздел или подраздел состоит из одного пункта, он также нумеруется. Если текст документа подразделяется только на пункты, они нумеруются порядковыми номерами в пределах документа. Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1, 4.2.1.2, 4.2.1.3 и т.д. Внутри пунктов или подпунктов могут быть приведены перечисления (в приложении MS Word они называются маркированными списками). Каждый пункт, подпункт и элемент перечисления пишут с абзацного отступа. Разделы и подразделы должны иметь заголовки, которые следует печатать с прописной буквы без точки в конце, не подчеркивая. Обратите внимание: переносы слов в заголовках не допускаются. Между заголовком и текстом, между заголовками раздела и подраздела должны быть увеличенные междустрочные интервалы. Каждый раздел документа рекомендуется начинать с новой страницы. В начале документа большого объема помещают содержание, включающее номера и наименования разделов и подразделов с указанием номеров страниц. Слово «Содержание» записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной. В п. 4.2 ГОСТ 2.105-95 приведены правила изложения текста документов. Эти правила адресованы в основном разработчикам ТЗ на АС, однако некоторые из них полезно знать всем работникам, чья деятельность связана с составлением и оформлением документов. Например, не только в тексте ТЗ, но и в тексте любого документа рекомендуется соблюдать ограничения, предусмотренные ГОСТ 2.105-95. Так, согласно подп. 4.2.3 ГОСТ 2.105-95 в тексте документа не допускается: – применять обороты разговорной речи, техницизмы, профессионализмы; – применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке; – применять произвольные словообразования; – применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе; – сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц и в расшифровках буквенных обозначений, входящих в формулы и рисунки. В соответствии с подп. 4.2.4 ГОСТ 2.105-95 в тексте документа, за исключением формул, таблиц и рисунков, не допускается: – применять математический знак минус (–) перед отрицательными значениями величин (следует писать слово «минус»); – применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»); – применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), ≥ (больше или равно), ≤ (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент). Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например: 1,50; 1,75; 2,00 м [3] Если в тексте документа приводят диапазон числовых значений физической величины, выраженных в одной и той же единице физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона. Например: От 1 до 5 мм. От плюс 10 до минус 40 °С. Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы). В подп. 4.2.21 ГОСТ 2.105-95 разъясняется, что примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания, и печатать с прописной буквы с абзаца. Если примечание одно, то после слова «Примечание» ставится тире и примечание печатается тоже с прописной буквы. Одно примечание не нумеруют. Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы. Примеры оформления примечаний: Примечание – ________________________________________________________ Примечания 1. __________________________________________________________________ 2. __________________________________________________________________ Правила оформления иллюстраций, приложений, таблиц и сносок Иллюстрации (п. 4.3 ГОСТ 2.105-95.), за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается: Рисунок 1. Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например: Рисунок А.3. Мелкие иллюстрации, которые размещены непосредственно в тексте и на которые в дальнейшем нет ссылок, допускается не нумеровать. Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой, например: Рисунок 1.1. Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 – Детали прибора. Приложение оформляют как продолжение данного документа на последующих его листах или выпускают в виде самостоятельного документа. При этом приложения располагают в порядке ссылок на них в тексте документа, за исключением информационного приложения «Библиография», которое располагают последним. Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «Приложение» и его обозначения, а под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного – «рекомендуемое» или «справочное». Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О. Если в документе одно приложение, оно обозначается «Приложение А». Нумерация разделов, подразделов, пунктов и подпунктов приложения производится в пределах каждого приложения. Перед номером ставится обозначение этого приложения. При этом приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц. Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их номеров и заголовков. Таблицы. Их построению посвящен п. 4.4 ГОСТ 2.105-95. Это наиболее полное и подробное описание правил создания и оформления таблиц в текстовых документах из тех, с которыми автору приходилось встречаться. Рассмотрим наиболее важные правила из тех, что приведены в п. 4.4 ГОСТ 2.105-95. Таблицы (за исключением таблиц приложений) следует нумеровать арабскими цифрами сквозной нумерацией. В каждом приложении таблицы нумеруют отдельно арабскими цифрами с указанием перед цифрой обозначения приложения. Например: Таблица 1 – если в документе одна таблица; Таблица В.1 – если таблица приведена в приложении В. Если таблицы нумеруются в пределах раздела, в номере через точку указывают номер раздела и порядковый номер таблицы. Заголовки граф и строк (см. рисунок) таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе. Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости – в приложении к документу. Если строки или графы таблицы выходят за формат страницы, ее делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют ее головку и боковик. Слово «Таблица» указывают один раз слева над первой частью таблицы, над другими частями (также слева) пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы. Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице, при этом во второй части повторяют головку таблицы. Рекомендуется разделять части таблицы двойной или более широкой линией. Графу «Номер по порядку» в таблицу включать не допускается. Если все показатели, приведенные в графах таблицы, выражены в одной и той же единице физической величины, то ее обозначение необходимо помещать над таблицей справа, а при делении таблицы на части – над каждой ее частью. Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321-84 «ЕСКД. Обозначения буквенные» (переиздан в марте 2002 г.), или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например D – диаметр, Н – высота, L – длина. Текст, повторяющийся в строках одной и той же графы и состоящий из одиночных слов, чередующихся с цифрами, заменяют кавычками (»). Если повторяющийся текст состоит из двух и более слов, при первом повторении его заменяют словами «То же», а далее кавычками. Если предыдущая фраза является частью последующей, то допускается заменить ее словами «То же» и добавить дополнительные сведения. Сноски. Их оформление регламентировано п. 4.5 ГОСТ 2.105-95. Согласно подп. 4.5.1 ГОСТ 2.105-95 сноски в тексте располагают с абзацного отступа в конце страницы, на которой они обозначены, и отделяют от текста короткой тонкой горизонтальной линией с левой стороны, а к данным, расположенным в таблице, – в конце таблицы над линией, обозначающей окончание таблицы. В соответствии с подп. 4.5.3 данного стандарта нумерация сносок производится отдельно для каждой страницы. В качестве знаков сноски используют арабские цифры со скобкой. Допускается вместо цифр выполнять сноски звездочками (*). Применять более четырех звездочек не рекомендуется. Правила оформления документов, приведенные в ГОСТ 2.105-95, проиллюстрированы рисунками, которые не приведены в статье, но с которыми имеет смысл ознакомиться – эти иллюстрации помогут вам лучше понять требования государственного стандарта. Задания Составить тех зад на разработку программных средств (ПС), либо информационных систем (ИС) по вариантам заданий: 1 ПС для управления работой банкомата 2 ПС для управления работой светофоров на перекрестке 3 ПС для управления работой системы лифтов здания 4 ПС для тестирования знаний 5 ИС учета товаров на складах 6 ИС отдела кадров 7 ИС деканата 8 ИС библиотеки 9 ИС интернет-магазина 10 ИС дистанционного обучения 11 ИС материального учета компьютеров Приложение А Форма титульного листа Приложение Б Форма последнего листа ТЗ на АС |