Методические указания по оформлению курсовых проектов (работ), для студентов специальности 2201 " Вычислительные машины, комплексы, системы и сети" (разработка программного обеспечения)

1 2 3 8 4 5 6 7 9 10 Рис. 1 Форма листа утверждения - 11 - Министерство образования Российской Федерации Волгоградский государственный технический университет Кафедра ЭВМ и систем У Т В Е Р Ж Д А Ю Зав. кафедрой ЭВМ и систем _________ проф. Духнич Е.И. Текстовый редактор “Edit” Описание программы ЛИСТ УТВЕРЖДЕНИЯ КР99.40461806.19425-01 13 01-ЛУ Руководитель разработки доцент каф. ЭВМ и систем _________ Деревенсков С.О. Исполнитель студент гр. ИВТ-362 __________ Крылов М.Н. Нормоконтролер _________ Кашина Г.А. 1999 Рис. 2 Пример заполнения листа утверждения - 12 - УТВЕРЖДЕН КР99.40461806.19425-01 13 01-ЛУ Текстовый редактор “Edit” Описание программы КР99.40461806.19425-01 13 01 Листов 42 1999 Рис. 3 Пример заполнения титульного листа - 13 - Техническое задание. Требования к содержанию и оформлению (ГОСТ 19.201-78) Настоящий стандарт устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения. 1. ОБЩИЕ ПОЛОЖЕНИЯ 1.1 Техническое задание оформляют в соответствии с ГОСТ 19.106-78 на листах формата А4 по ГОСТ 2.301-68. Номера листов (страниц) проставляют в верхней части листа над текстом. 1.2 Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104-78. Информационную часть (аннотацию и содержание ), лист регистрации изменений допускается в документ не включать. 1.3 Для внесения изменений или дополнений в техническое задание на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для технического задания. 1.4 Техническое задание должно содержать следующие разделы: введение; основание для разработки; назначение разработки; требования к программе или программному изделию; требования к программной документации; технико-экономические показатели; стадии и этапы разработки; порядок контроля и приемки; в техическое задание допускается включать приложения. В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них. СОДЕРЖАНИЕ РАЗДЕЛОВ 2.1 В разделе “Введение” указывают наименование, краткую характеристику области применеия программы или программного изделия и объекта, в котором используют программу или программное изделие. 2.2 В разделе “Основания для разработки” должны быть указаны: документ (документы), на основании которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование и (или) условное обозначение темы разработки. - 14 - 2.3 В разделе “Назначение разработки” должно быть указано функциональное и эксплуатационное назначение программы или программного изделия. 2.4 Раздел “Требования к программе или программному изделию” должен содержать следующие подразделы: требования к функциональным характеристикам; требования к надежности; условия эксплуатации; требования к составу и параметрам технических средств; требования к информационной и программной совместимости; требования к маркировке и упаковке; требования к транспортированию и хранению; специальные требования. 2.4.1 В подразделе “Требования к функциональным характеристикам” должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т.п.); 2.4.2 В подразделе “Требования к надежности” должны быть указаны требования к обеспечению надежного функционирования (обеспечение устойчивости, контроль входной и выходной информации, время восстановления после отказа и т.п.); 2.4.3 В подразделе “Условия эксплуатации” должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала. 2.4.4 В подразделе “Требования к составу и параметрам технических средств” указывают необходимый состав технических средств с указанием их основных технических характеристик. 2.4.5. В подразделе “Требования к информационной и программной совместимости” должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой. При необходимости должна обеспечиваться защита информации и программ. 2.4.6 В подразделе “Требования к маркировке и упаковке” в общем случае указывают требования к маркировке программного изделия, варианты и способы упаковки. 2.4.7 В подразделе “Требования к транспортированию и хранению” должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях. 2.5а В разделе “Требования к программной документации” должен быть указан предварительный состав программной документации и, при необходимости, специальные требования к ней. - 15 - 2.5 В разделе “Технико-экономические показатели” дожны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами. 2.6 В разделе “Стадии и этапы разработки” устанавливают необходимые стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и определяют исполнителей. 2.7 В разделе “Порядок контроля и приемки” должны быть указаны виды испытаний и общие требования к приемке работы. 2.8 В приложениях к техническому заданию, при необходимости, приводят: перечень научно-исследовательских и других работ, обосновывающих разработку; схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке; другие источники разработки. Описание программы (ГОСТ 19.402-78). 1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа “Описание программы”, определенного ГОСТ 19.101-77. 2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. 3. Описание программы должно содержать следующие разделы: общие сведения; функциональное назначение; описание логической структуры; используемые технические средства; вызов и загрузка; входные данные; выходные данные. В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы. 4. В разделе “Общие сведения” должны быть указаны: обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; языки программирования, на которых написана программа. - 16 - 5. В разделе “Функциональное назначение” должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение. 6. В разделе “Описание логической структуры” должны быть указаны: алгоритмы программы; используемые методы; структура программы с описанием функций составных частей и связи между ними; связи программы с другими программами. Описание логической структуры программы выполняют с учетом текста программы на исходном языке. 7. В разделе “Используемые технические средства” должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы. 8. В разделе “Вызов и загрузка” должны быть указаны: способ вызова программы с соответствующего носителя данных; входные точки в программу. Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы. 9. В разделе “Входные данные” должны быть указаны: характер, организация и предварительная подготовка входных данных; формат, описание и способ кодирования входных данных. 10. В разделе “Выходные данные” должны быть указаны: характер и организация выходных данных; формат, описание и способ кодирования выходных данных. 11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками. 12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания. Текст программы. Требования к содержанию и оформлению (ГОСТ 19.401-78) 1. Настоящий стандарт устанавливает состав и требования к содержанию и оформлению программного документа “Текст программы”, определенного ГОСТ 19.101-77. 2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является необязательным. Для текста программы на исходном языке при наличии аннотации в нее включают краткое описание функций программы. 3. Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования. - 17 - Допускается вводить наименование также и для совокупности разделов. 4. Каждый из этих разделов реализуется одним из типов символической записи, например: символическая запись на исходном языке; символическая запись на промежуточных языках; символическое представление машинных кодов и т.п. В символическую запись разделов рекомендуется включать комментарии, которые могут отражать, например, функциональное назначение, структуру. Программа и методика испытаний. Требования к содержанию и оформлению (ГОСТ 19.301-79) Настоящий стандарт устанавливает состав и требования к содержанию и оформлению программного документа “Программа и методика испытаний”, определенного ГОСТ 19.101-77. 1. ОБЩИЕ ПОЛОЖЕНИЯ 1.1 Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является необязательным. 1.2 Документ “Программа и методика испытаний” должен содержать следующие разделы: объект испытаний; цель испытаний; требования к программе; требования к программной документации; средства и порядок испытаний; методы испытаний. В зависимости от особенностей документа допускается вводить дополнительные разделы. СОДЕРЖАНИЕ РАЗДЕЛОВ 2.1 В разделе “Объект испытаний” указывают наименование, область применения и обозначение испытуемой программы. 2.2 В разделе “Цель испытаний” должна быть указана цель проведения испытаний. 2.3 В разделе “Требования к программе” должны быть указаны требования, подлежащие проверке во время испытаний и заданные в техническом задании на программу. 2.4 В разделе “Требования к программной документации” должны быть указаны состав программной документации, предъявляемой на испытания, а также специальные требования, если они заданы в техническом задании на программу. - 18 - 2.5 В разделе “Средства и порядок испытаний” должны быть указаны технические и программные средства, используемые во время испытаний, а также порядок проведения испытаний. 2.6 В разделе “Методы испытаний” должны быть приведены описания используемых методов испытаний. Методы испытаний рекомендуется по отдельным показателям располагать в последовательности, в которой эти показатели расположены в разделах "Требования к программе" и "Требования к программной документации". В методах испытаний должны быть приведены описания проверок с указанием результатов проведения испытаний (перечней тестовых примеров, контрольных распечаток тестовых примеров и т.п.). 2.7 В приложение к документу могут быть включены тестовые примеры, контрольные распечатки тестовых примеров, таблицы, графики и т.п. Руководство системного программиста. Требования к содержанию и оформлению (ГОСТ 19.503-79) Настоящий стандарт устанавливает состав и требования к содержанию и оформлению программного документа “Руководство системного программиста”, определенного ГОСТ 19.101-77. 1. ОБЩИЕ ПОЛОЖЕНИЯ 1.1 Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. 1.2 Руководство системного программиста должно содержать следующие разделы: общие сведения о программе; структура программы; настройка программы; проверка программы; дополнительные возможности; сообщения системному программисту. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. В обоснованных случаях допускается раздел "Дополнительные возможности" не приводить, а в наименованиях разделов опускать слово "программа" или заменять его на «наименование программы». 2. СОДЕРЖАНИЕ РАЗДЕЛОВ 2.1 В разделе “Общие сведения” должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы. - 19 - 2.2 В разделе “Структура программы” должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами. 2.3 В разделе “Настройка программы” должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.). При необходимости приводят поясняющие примеры. 2.4 В разделе “Проверка программы” должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты). 2.5 В разделе “Дополнительные возможности” должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора. 2.6 В разделе “Сообщения системному программисту” должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям. 2.7 В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы,графики и т.п.).

Похожие:

	Российской Федерации Федеральное агентство по образованию Государственное... Методические указания предназначены для закрепления теоретических знаний и приобретения необходимых практических навыков и умений...		Методические указания к оформлению выпускной квалификационной работы... Методические указания предназначены для более глубокого изучения и применения требований ескд и спдс по структуре и правилам оформления...
	Рабочая программа дисциплины «Социология» «Социология» по специальности 230101. 65 Вычислительные машины, комплексы, системы и сети		Методические указания по экономическому обоснованию дипломных проектов... Рощина А. А. Методические указания по экономическому обоснованию дипломных проектов для студентов специальности: Электронные вычислительные...
	Методические рекомендации по оформлению курсовых работ и дипломных... Методические рекомендации по оформлению курсовых работ и дипломных проектов. Чернушка: гбоу спо «кпк», 2014. – 65 с., тираж 20		Методические указания для самостоятельной работы студентов Новосибирск... Методические указания предназначены для самостоятельного оформления курсовых и дипломных проектов, выполняемых студентами специальности...
	Методические рекомендации по выполнению и оформлению курсовых работ... Методические рекомендации по выполнению и оформлению курсовых работ для студентов по специальности 080111. 65 «Маркетинг» разработаны...		Методические рекомендации и практические советы по написанию и оформлению... Настоящие методические указания по подготовке дипломных работ предна­значены для студентов выпускников, обучающихся по специальности...
	Методические указания по оформлению курсовых и дипломных проектов... Разработчики: Волотова Елена Ивановна, преподаватель гбпоу «Авиационный техникум»		Методические указания По оформлению пояснительных записок курсовых... ...