Методические указания к дипломному проектированию. Метод_указ_ДП_2017. Методические указания к дипломному проектированию Специальность 1304000 втипо квалификация 1304043 техникпрограммист
 Скачать 126.5 Kb.
|
|
УПРАВЛЕНИЕ образования ЮЖНО-КазахстанСКОЙ ОБЛАСТИ «ЮЖНО-КАЗАХСТАНСКИЙ ПОЛИТЕХНИЧЕСКИЙ КОЛЛЕДЖ» методические указания к дипломному проектированию Специальность 1304000 ВТиПО Квалификация 1304043 техник-программист Разработала Убайдуллаева И.М. Рассмотрено На заседании ПЦК Программирования и АС Протокол № ____ от __________ Председатель ПЦК ___________ г. Шымкент 2017г. ВВЕДЕНИЕ Выпускники специальности 1304000 – «Вычислительная техника и программное обеспечение» квалификации 1304043 «техник-программист» должны быть подготовлены для самостоятельной работы во всех сферах, связанных с разработкой, внедрением, сопровождением и эксплуатацией программного обеспечения вычислительной техники и автоматизированных систем в организациях научного, проектного, финансового и конструкторского профиля, на промышленных предприятиях и в учебных заведениях в первичных программиста и смежных специальностей, предусмотренных для замещения специалистами образованием типовыми номенклатурами должностей . Специалист должен быть подготовлен для исследовательской, проектной, конструкторской и организационной управленческой деятельности в области создания, сопровождения , эксплуатации и контролер качества программного обеспечения средств вычислительной техники и автоматизированных систем управления средств вычислительной техники для решения новых задач из различных областей человеческой деятельности . Дипломное проектирование является составной частью учебного процесса, его завершающим этапом, в течение которого систематизируются и закрепляются практические навыки студента в решении конкретных вопросов и задач , расширяются теоретические знания , проверяется его подготовленность к самостоятельной работе. Его основная цель - окончательная проверка способности студента самостоятельно на основе полученных в обучения знаний, умений и навыков выполнять разработку программных средств для решения на ЭВМ разнообразных задач специального и прикладного и назначения. Дипломный проект представляет квалификационную работу, на основе защиты которой Государственная экзаменационная комиссия выносит решение о присвоении его автору квалификации техника-программиста . В связи с этим к завершению и оформлению дипломного проекта предъявляются определенные требования , которые изложены в настоящем методическом пособии. 1. ЦЕЛИ И ЗАДАЧИ ДИПЛОМНОГО ПРОЕКТИРОВАНИЯ. Дипломное проектирование имеет целью: Систематизацию, закрепление и расширение теоретических и практических знаний по разработке программного обеспечения вычислительной техники и автоматизированных систем ; Развитие инженерного подхода к разработке программного обеспечения (ПО) ЭВМ, охватывающий ; 2.1 Основные этапы разработки программного обеспечения, начиная от этапа предварительного проектирования (системного анализа) и заканчивая сдачей готового программного продукта заказчику. 2.2 Методологию процесса программирования, обеспечивающую заданный уровень производительности труда техника-программиста и качество получаемой в результате программной продукции; 2.3 Способы и средства автоматизации разработки, отладки и испытания программ для различных типов ЭВМ; 2.4 Обеспечение надёжности программных изделий; 2.5 Применение диалогового (интерактивного) режима работы, языков программирования различного уровня, баз данных и других современных автоматизированных средств повышения производительности труда техников-программистов; 2.6 Использование опыта ряда прогрессивных и зарубежных технологий создания сложных комплексов и программ; 2.7 Стандарты, руководящие документы документирования разработки программного обеспечения. 3) Развитие навыков ведения самостоятельной работы в области исследования, организации и проектирования систем программного обеспечения. 4) Совершенствование в проведении технико-экономического анализа, выбора условия работ, отвечающих требованиям охраны труда. 5) Разработка программных средств с использованием диалогового (интерактивного) режима работы на основе языков программирования, систем управления базами (СУБД), систем управления базами знаний (СУБЗ), пакетов прикладных программ (ППП) и других современных средств повышения производительности труда программиста. 6) Определение степени подготовлённости студента самостоятельно использовать полученные им знания при решении конкретных задач. 2. ТЕМАТИКА ДИПЛОМНОГО ПРОЕКТИРОВАНИЯ. Тематика дипломных проектов должна соответствовать профилю специальности – программное обеспечение вычислительной техники и автоматизированных систем, быть актуальной, отражать современное состояние и перспективы развития соответствующих областей науки, техники и отраслей хозяйства. Конкретные темы дипломных проектов должны соответствовать со следующими тематическими группами. Тема дипломного проекта может относиться к одной из следующих групп: - системное программное обеспечение; - прикладные программы общего назначения; К программным средствам системного программного обеспечения входят следующие группы программ: - системы управления базами данных (управление файлами); - системы управления коммуникациями, эмуляторы; - компиляторы с языков программирования, кросскомпилляторы; - средства межмашинного обмена; - средства защиты от несанкционированного доступа; - операционные системы; - системы разработки прикладных программ; - средства расширения операционных систем; К прикладным программам общего назначения можно отнести: - обучающие системы; - средства обработки тестов (текстовые редакторы); - средства машинной графики; - финансовое планирование и анализ; - статистика-математика; - автоматизация учреждений; - домашние информационные системы и др. К прикладным программным средствам специального назначения относятся программные средства, расширяющие сферы применения ЭВМ: - сельское хозяйство; - управление капиталовложением; - здравоохранение; - банковское дело и т.п. 3.ОРГАНИЗАЦИЯ ДИПЛОМНОГО ПРОЕКТИРОВАНИЯ. Дипломные проекты могут выполняться в научно-производственных объединениях, научно-исследовательских, проектных и учебных заведениях, имеющих вычислительные центры, а также в организациях и на предприятиях (совместных, арендных и др.), оснащённых вычислительной техникой и имеющих в составе инженеров-программистов с большим опытом разработки программного обеспечения ЭВМ. Дипломное проектирование по возможности должно проводиться там, куда направляется на работу молодой специалист. Руководителями дипломного проектирования могут быть преподаватели предметно-цикловой комиссии, высококвалифицированные специалисты предприятий и организаций с базовым образованием инженера-программиста или смежной специальности. Перед началом преддипломной практики будущий выпускник получает на кафедре два экземпляра бланка задания по дипломному проектированию (см. приложения 1). Из них один экземпляр будет вшит в записку дипломного проекта. В течение первой недели преддипломной практики предполагаемый руководитель дипломного проекта должен выдать студенту за своей подписью обоснование избранной темы дипломного проекта и задание по дипломному проекту. Представленные материалы обсуждаются и утверждаются на заседании предметно-цикловой комиссии . После утверждения тем дипломных проектов они приобретают силу приказа и не подлежат изменению. К сдаче зачёта по преддипломной практике выпускник должен представить; - отчёт по преддипломной практике; - дневник прохождения преддипломной практики; - один экземпляр заполненного бланка – задания на дипломное проектирование (другой экземпляр остаётся у выпускника). Руководитель дипломного проекта осуществляет непосредственное руководство всей работой выпускника над дипломным проектом. Кроме того, предметно-цикловая комиссия может назначить ответственных консультантов по отдельным разделам дипломного проекта с правом подписи титульного листа и листов графической части. РУКОВОДИТЕЛЬ ДИПЛОМНОГО ПРОЕКТИРОВАНИЯ: - выдаёт задание по дипломному проекту; - оказывает выпускнику помощь в составлении календарного плана работы на весь период дипломного проектирования; - рекомендует необходимую литературу; справочные и другие материалы по теме; - оказывает содействие в выделении выпускнику достаточного машинного времени; - регулярно консультирует выпускника; - контролирует ход выполнения дипломного проекта; - даёт письменный отзыв о выполненном дипломном проекте. Во время преддипломной практики дипломаты полностью подчиняются правилам внутреннего распорядка организации, где они проходят. Следует отметить, что за принятое в работе решение, правильность использования служебных материалов, всех данных технологических разработок и вычислений, работоспособность программного обеспечения отвечает студент – автор дипломного проекта. СОДЕРЖАНИЕ ДИПЛОМНОГО ПРОЕКТА И ТРЕБОВАНИЯ К ЕГО ОФОРМЛЕНИЮ. Дипломный проект должен быть на реальную тему и отражать направленность специальности 1304000 – Вычислительная техника и программное обеспечение. Дипломный проект состоит из пояснительной записки и графического материала. Пояснительная записка должна в краткой и четкой форме раскрывать творческий замысел проекта и содержать: титульный лист (приложение I); расчетно-пояснительная записка (приложение 2); задание по дипломному проекту (приложение 3); конверт (отзыв руководителя, рецензия ); аннотацию (приложение 4); содержание (приложение 5); введение; общую часть; специальную часть; экономическую часть; основы безопасности жизнедеятельности; заключение; список использованной литературы приложения. Ориентировочный объем пояснительной записки 60-100 страниц. Рекомендуемый объем графической части 1-3 листов. Текст пояснительной записки излагается грамотным литературным и техническим языком и должен полно освещать тему проекта и представлять собой законченное целое. Пояснительная записка должна быть отпечатана через 1,3 интервала, шрифт Times New Roman размером 14 . Заголовки разделов пишутся 16 размером, шрифтом Times New Roman. Оформление пояснительной записки должно выполняться в соответствии с требованиями ЕСКД к текстовым и графическим материалам. Ссылки на литературу в пояснительной записке указываются в квадратных скобках согласно номеру в списке использованной литературы. Содержание ПЗ раскрывает вопросы задания и пишется в той последовательности, которая предложена в задании. При изложении материала необходимо придерживаться логической структуры, давать анализ и выводы по результатам расчетов. Изложение материала в ПЗ должно идти от первого лица множественного числа (определяем, выбираем, принимаем) или может быть использована неопределенная форма (определяется, выбирается, следует считать целесообразным и т. п.). Записка представляется к защите переплетенной или сброшюрованной в специальной папке. 1.1. Введение. Во введении излагается актуальность предложенной темы дипломного проекта. Здесь же дается очень краткое содержание всех остальных частей дипломного проекта, всего не более 1-3 страниц. Общая часть. Общая часть должна дать представление о выбранном языке программирования, СУБД и содержать не более 20-25 страниц. В общей части не должно быть никаких таблиц, рисунков, схем. Все таблицы, рисунки и схемы помещаются в приложении, а в пояснительной части текста даётся ссылка на них. Специальная часть. Специальная часть должна содержать: 1) Постановку задачи Дается описание рассматриваемой функциональной подсистемы, список основных задач и программные средства поддержки. В том числе типовые и разрабатываемые в проекте. В заключение выполняется постановка задачи на проектирование программных средств, которая предполагает выполнение следующих работ: сбор исходных данных; выбор и обоснование критериев эффективности и качества разрабатываемых программных средств; обоснование необходимости проведения научно-исследовательских работ; определение структуры входных и выходных данных, область применимости задачи; обоснование принципиальной возможности решения поставленной задачи. В этой главе приводится также сравнительный анализ существующих программных средств решения данного класса задач. 2) Алгоритм решения В этом разделе приводится решение поставленной задачи. В частности. описываются формализованные структуры входных и выходных данных, базы данных. Здесь приводится обоснование выбранных методов и алгоритмы разрабатываемых программных средств с обязательным указанием системных, межмодульных интерфейсов и интерфейсов с используемыми ППП. 3) Графическая часть (блок-схема) Дается графическая реализация решений поставленной задачи, результаты рабочего проектирования создаваемого программного обеспечения. Все чертежи выполняется в соответствии с ГОСТ - ами и нормами ЕСКД (единая система конструкторской документации). На листе блок-схемы должна быть широкая рамка и основная надпись. 4) Листинг программы Привести распечатки созданных программ и модулей. Каждые процедуры нужно озаглавить с подробными комментариями . 5) Организация производства Все программные разработки, выполненные в предыдущих главах дополняются необходимым документальным сопровождением, включающем полное описание с указанием всех существующих ограничений в части применения и рекомендации по выбору устанавливаемых параметров эксплуатации, приведенные в «Инструкции программисту» и «Инструкции пользователю», смотри в приложении 8,9. Все инструкции должны представлять собой самостоятельный, независимый документ и могут содержать фактически реализованные ответы на вопросы, перечисленные в постановке задачи. Руководство программисту содержит сведения, необходимые при модификации программ или при необходимости исправить в ней ошибку. Для чего максимально раскрыть реализованную внутреннюю логику изделия, ссылаясь на соответствующие листинги программ. Следует помнить, что программист знаком с конструкциями используемого языка программирования. Руководство пользователю предназначается при эксплуатации программного изделия пользователем, который чаще всего не является программистом. В нем описывается, как пользоваться программным изделием: полное описание подготовки ЭВМ к работе с программным изделием; правило подготовки и ввода входных данных; описание всех режимов работы изделия, если таковые имеются; необычные ситуации в программном изделии, реакцию пользователя на них; перечень всех диагностических сообщений, которые выдаются по ходу выполнения программного изделия и ответы пользователя на них; действия пользователя после окончания его работы с программным изделием. Экономическая часть. Структура экономической части следующая: обоснование экономической целесообразности разработанного дипломного проекта; экономическое обоснование избранного пути решения задачи и выбор базы хранения для определения экономического эффекта от внедрения проекта в конкретных производственных условиях; определение затрат на проектирование программного обеспечения; определение себестоимости программного обеспечения (прямых и косвенных затрат); определение эксплуатационных расходов годовой экономики и годовой экономической эффективности от внедрения программного обеспечения, Расчет и анализ: технико-экономических показателей проекта применительно к теме проекта и данному звену производства (предприятия, отдела, организации), дать характеристику организации труда персонала, сбора, передачи, хранения и технологии обработки информации; При написании этого раздела выпускник должен показать степень развития основ экономического мышления, умение проводить технико-экономические расчеты, владение методами оптимальной организации и научной организации труда, наличие навыков эффективности использования материальных, трудовых и финансовых ресурсов, расчета и анализа технико-экономических показателей решаемой задачи. Объем раздела примерно 10-12 страниц. В процессе работы над дипломным проектом выпускник обязан посещать консультации, организуемые консультантом по экономической части. Основы безопасности жизнедеятельности. Раздел ОБЖ имеет следующую структуру: анализ условий труда с точки зрения возможных (потенциальных) вредных воздействий опасностей, создаваемых средствами вычислительной техники, технологическими процессами, неправильной организацией труда на рабочих местах и в производственных помещениях; разработка мероприятий по охране труда, обеспечивающих устранение или уменьшение воздействия вредного (опасного) фактора на организм работающих выявленных при работе с ЭВТ; вопросы пожарной профилактики, определение пожарной категории ВЦ, ИВЦ, отдела АСУТП и т.п., степени относительности помещения. Приводятся решения по системам пожарной сигнализации, связи, системам пожаротушения; вопросы освещения рабочих мест, вентиляции помещении, где находятся ЭВТ; меры безопасности и защиты при работе со средствами ЭВТ; решения по производственной эстетике - художественное оформление интерьера производственного помещения для рабочего места. Особое внимание уделяется взаимосвязи человека и средств ЭВТ, организации рабочего места техника-программиста. При написании раздела дипломант должен показать умение пользоваться литературой и системой стандартов безопасности труда для самостоятельной оценки опасности и вредности производственной среды. Не допускается механическое переписывание ведомственных инструкций и нормативной литературы по охране труда. Литература, использованная при разработке вопросов охраны труда, приводится в общем перечне литературы по проекту. В случае необходимости, в графической части проекта может представляться лист, отражающий конструктивные решения по охране труда. Объем раздела примерно 12-15 страниц. В процессе работы над дипломным проектом выпускник обязан посещать консультации, организуемые консультантом по охране труда. 1.6. Заключение. В заключении должен быть сделан вывод по общей и специальной части, разделам охраны труда и экономики: о практической реализации требований пользователя; о целесообразности выбранного метода решения задачи и предложенного материала; о программной реализации поставленной задачи. Изложить рекомендации по использованию программного изделия, возможные его расширения в будущем. 1.7. Список использованной литературы. Приводится перечень всех использованных при разработке дипломного проекта литературных источников по следующим правилам: Для книг - фамилии и инициалы авторов, наименование, издательство, год издания. Например: Роджерс Д. Алгоритмические основы машинной графики. М.: Мир, 1989. Для журнальных статей - фамилии и инициалы авторов , заголовок (название) журнала, год издания, том, номер, страницы. Например: Беляев С.Ю., Козелецкий Г.В. Визуализация трехмерных сцен в реальном времени на IBM PC/AT// Программирование, 1992.№4x40-52. 1.8. Приложения. В приложении необходимо привести формы входных и выходных данных. форменные бланки, таблицы, рисунки и т.п., на которые имеется ссылка в записке дипломного проекта. 1.9. Требования к оформлению пояснительной записки. Пояснительная записка дипломных проектов оформляется в соответствии с ГОСТ 2.104 — 68 и ГОСТ 2.105—79. Первым листом пояснительной записки является титульный лист (он не нумеруется). После титульного листа располагают бланк с заданием на дипломное проектирование, который также не нумеруют. Затем подшивается конверт, в который вкладывается отзыв руководителя и рецензия. После конверта располагается аннотация к дипломному проекту. На первом (заглавном) листе пояснительной записки помещают содержание. Слово «содержание» записывают в виде заголовка (симметрично к тексту). Далее с абзаца приводят наименования разделов, подразделов и приложений пояснительной записки и указывают номера листов, с которых они начинаются. На заглавном листе пояснительной записки, листе блок-схемы и листах перед каждым разделом помещают также штамп в соответствии с ГОСТ 2.104—68 ( Приложение 5,6), на остальных листах пояснительной записки оформляют штамп в соответствии с ГОСТ 2.104— 68 ( Приложение7). В основной надписи штампов указывается обозначение дипломного проекта. Например: на листе содержания, блок-схем и первых листах перед разделами пояснительной записки указывается надпись ДП.1304.103к.12.ПЗ, что означает дипломный проект, шифр специальности, учебной группы, номер студента в группе, пояснительная записка. На текстовых листах указывается надпись вида ДП.1304.152.12.В или ДП.1304.152.12.ОЧ и т.п. в зависимости от аббревиатуры раздела пояснительной записки. Пояснительная записка оформляется на одной стороне листа формата А4. На каждом листе располагают основную надпись согласно приложениям. Текст пояснительной записки набирается на компьютере - шрифт Times New Roman размером 14. Расстояние от рамки формата до границ текста следует оставлять: в начале строк — не менее 5 мм, в конце — не менее 3 мм. Абзацы в тексте начинают с отступом 15... 17 мм. Объем ПЗ от 60 до 100 листов текста. Содержание, блок-схема заполняется в соответствии с приложением 5. Перед каждым разделом вставляется лист, который заполняется согласно приложению 6. Вся текстовая часть помещается в рамку согласно приложению 7. Текст пояснительной записки разделяют на разделы и подразделы. Наименования разделов и подразделов должны быть краткими. Наименования разделов записывают в виде заголовков (симметрично к тексту) строчными буквами (кроме первой прописной) шрифтом Times New Roman размером 16. Наименования подразделов записывают в виде заголовков (симметрично к тексту) строчными буквами (кроме первой прописной) шрифтом Times New Roman размером 14. Переносы слов в заголовках не допускаются, точку в конце заголовка не ставят. Если заголовок состоит из двух предложений, то их разделяют точкой. Расстояние между заголовком и текстом должно быть примерно 15 мм, расстояние между заголовками раздела и подраздела — примерно 5...7 мм. Каждый раздел пояснительной записки рекомендуется начинать с нового листа (страницы). Разделы должны иметь порядковые номера, обозначенные арабскими цифрами без точки, например: 1 ; 2 ; 3 и т.д. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела также не ставится точка, например: 1.1, 1.2 ; 1.3 и т.д. Подразделы могут состоять из нескольких пунктов. Номер пункта должен состоять из номера раздела, подраздела и пункта, разделенных точкой, например: 2 1.1; 2.1.2 ; 2.1.3 и т д. Содержащиеся в тексте пункта или подпункта перечисления требований, указаний, положений обозначают арабскими цифрами со скобкой, например: 1), 2), 3) и т. д. Каждый пункт, подпункт и перечисление записывают с абзаца ЗАЩИТА ДИПЛОМНЫХ ПРОЕКТОВ Для проверки подготовленности выпускаемых специалистов и присвоения им квалификации в колледже создаются Государственные аттестационные комиссии (ГАК) в составе председателя и членов комиссии. Ответственный секретарь ГАК назначается директором колледжа из состава членов Государственной аттестационной комиссии. Для защиты дипломных проектов ГАК должны быть представлены следующие материалы: 1) выполненные дипломные проекты с письменными отзывами руководителей и с рецензиями 2) сведения об успеваемости учащихся по всем предметам, а также о выполнении ими всех требований учебного плана; 3) списки учащихся, допущенных к защите дипломного проекта. 4) характеристики дипломников Работа ГАК проводится согласно установленному расписанию, которое должно быть объявлено в колледже не позднее чем за 1 день до начала защиты. Допуск учащихся к защите объявляется приказом по колледжу. За 2 недели до официальной защиты председателю предметно-цикловой комиссии, руководителям и консультантам дипломного проектирования рекомендуется организовать предварительную защиту дипломных проектов. Официальная защита дипломных проектов, происходящая на открытом заседании ГАК, состоит из трех этапов. 1) доклад дипломника; 2) ознакомление членов ГАК с отзывом руководителя и рецензией; 3) ответы на вопросы членов ГКК. При защите дипломных проектов каждому учащемуся отводится 15... 20 мин для доклада. В докладе учащемуся необходимо: 1) в убедительной форме обосновать целесообразность разработки данного программного продукта, методики эксплуатации (в соответствии с темой); 2) кратко изложить принцип работы программного комплекса и привести основные технические параметры, не сводя изложение к мелкой детализации ; 3) доказать рациональность принятого решения исходя из технических требований и проведенных расчетов, а также по технологическим (эксплуатация, ТО и ремонт), экономическим соображениям, правилам безопасности труда; 4) показать, что нового предлагается в проекте (принципиально новый алгоритм решения, метод; новая элементная база; новая прогрессивная технология с применением новых программно- аппаратных средств и т. п.); 6) изложить результаты экономических расчетов, которые показывают целесообразность разработки или внедрения в производство предлагаемых решений, проводимой модернизации аппаратно-программных средств и т.д. Желательно доклад предварительно выполнить в письменной форме и самым обстоятельным образом проработать, помня, что доклад надо делать от первого лица множественного числа: «устанавливаем», «настраиваем». Может быть использована неопределенная форма: «следует считать целесообразным» и т. п. Во время доклада важно правильно использовать графический материал дипломного проекта, делая ссылки на схемы, графики и т.п. Хорошо продуманный и выполненный доклад, умелое использование графического материала, правильное применение технической терминологии существенно влияют на решение ГКК. По окончании доклада зачитывается отзыв руководителя и рецензия. Затем слово предоставляется дипломнику для ответа на замечания рецензента. Для выявления степени подготовленности учащихся члены ГКК могут задавать вопросы, относящиеся к содержанию дипломного проекта, будущей специальности, задачам, которые призваны решать информационные технологии. Для того чтобы ответы были убедительными, аргументированными и технически грамотными, дипломник должен ясно представлять себе принцип действия, назначение каждого модуля программного продукта. Дипломник должен быть готов к ответам на вопросы: где применяется разработанное программное обеспечение? чем вызвана необходимость разработки нового подхода к решаемой задаче каков экономический эффект и за счет чего он может быть получен, себестоимость и срок окупаемости программного комплекса основные понятия теории баз данных на основании каких соображений выбран язык программирования и владение инструментарием выбранного языка каковы технические требования, предъявляемые к программному обеспечению как реализованы требования к технологическому процессу с точки зрения правил безопасности труда Решение об оценке дипломного проекта и о присвоении квалификации принимаются Государственной квалификационной комиссией на закрытом заседании большинством голосов. При оценке дипломного проекта необходимо учитывать практическую ценность дипломного проекта и его хозяйственное значение; качество оформления проекта, грамотность составления пояснительной записки; содержание доклада и четкость ответов на вопросы; практическую и теоретическую подготовку учащегося; отзывы рецензента и руководителя дипломного проекта. Решение ГАК об оценке дипломных проектов и о присвоении квалификации объявляется председателем после окончания заседания. Учащимся, окончившим колледж, в торжественной обстановке вручаются дипломы. По окончании защиты дипломных проектов председатель ГАК представляет отчет о работе комиссии. Приложение 8 Руководство программиста. (ГОСТ 19.504-79) Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста» определенного ГОСТ 19.101—77. 1. ОБЩИЕ ПОЛОЖЕНИЯ 1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105—79. Составление информационной части (аннотации и содержания) является обязательным. 1.2. Руководство программиста должно содержать следующие разделы: назначение и условия применения программы; характеристики программы; обращение к программе; входные и выходные данные; сообщения. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. 1. СОДЕРЖАНИЕ РАЗДЕЛОВ 2.1. В разделе «Назначение и условия применения программы» должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы .(объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т. п.). 2.2. В разделе «Характеристики программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.). 2.3. В разделе «Обращение к программе» должно быть приведено -описание процедур вызова программы (способы передачи управления и параметров данных и др.). 2.4. В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования. 2.5. В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям. 2.6. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.). Приложение 9 Руководство пользователя. (ГОСТ 19.505-79) Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство оператора», определенного ГОСТ 19.101-77. 1. ОБЩИЕ ПОЛОЖЕНИЯ 1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105—79. Составление информационной части (аннотации и содержания) является обязательным. Руководство оператора должно содержать следующие разделы: назначение программы; условия применения; пуск программы; команды оператора; сообщения оператору. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. 2. СОДЕРЖАНИЕ РАЗДЕЛОВ 2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функции программы и ее эксплуатации. 2.2. В разделе «Условия применения» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т. п.). 2.3. В разделе «Пуск программы» должны быть указаны действия, которые необходимо выполнить оператору ЭВМ для обеспечения загрузки и выполнения программы. 2.4. В разделе «Команды оператора» должно быть приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также порядок действий оператора (например, возврат на контрольную точку, прекращение работы и т. п.). 2.5. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т. п.). 2.6. В приложении к руководству оператора могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.). |