Методические указания по выполнению практических работ для подготовки обучающихся специальности
 Скачать 0.53 Mb.
|
|
Описание применения - Документ "Описание применения" относится к эксплуатационным до- кументам и состоит из следующих разделов: - назначение программы (возможности, основные характеристики, огра- ничения области применения); - условия применения (требования к техническим и программным сред- ствам, общие характеристики входной и выходной информации, а также требо- вания и условия организационного, технического и технологического характе- ра); - описание задачи (указываются определения задачи и методы её реше- ния); - входные и выходные данные. Руководство программиста 28 Документ "Руководство программиста" относится к эксплуатационным документам и включается в программную документацию, если разработанный программный продукт требует обслуживания программистом. Документ состо- ит из следующих разделов: - назначение и условия применения программы (назначение и функции программы, сведения о технических и программных средствах, обеспечиваю- щих выполнение данной программы); - характеристики программы (временные характеристики, режимы рабо- ты, средства контроля правильности выполнения и т. п.); - обращение к программе (способы передачи управления и параметров данных); - входные и выходные данные (формат и кодирование); - сообщения (тексты сообщений, выдаваемых программисту или опера- тору в ходе выполнения программы и описание действий, которые необходимо предпринять по этим сообщениям). Руководство оператора - Документ "Руководство оператора" относится к эксплуатационным до- кументам и состоит из следующих разделов: - назначение программы (информация, достаточная для понимания функций программы и её эксплуатации); - условия выполнения программы (минимальный и/или максимальный набор технических и программных средств и т. п.); - выполнение программы (последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы; опи- сываются функции, форматы и возможные варианты команд, с помощью кото- рых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды); - сообщения оператору (тексты сообщений, выдаваемых оператору в хо- де выполнения программы и описание действий, которые необходимо пред- принять по этим сообщениям). Таблица1 Перечень объектов контроля и оценки Наименование объектов контроля и оценки Основные показатели оценки результата У 4. Оформлять документацию на про- граммные средства. Текстовый документ, выполненный согласно общим положе- ниям о стандартах документирования программных средств У 5. Использовать инструментальные средства для автоматизации оформле- ния документации. Использование текстового редактора. З 3. Основные принципы отладки и тестирования программных продуктов Изложение требований к тестированию, определение гранич- ных точек, контроль задания на граничных точках, тестирова- ние программы как чёрного ящика, как белого ящика, пошаго- вое тестирование, восходящее тестирование, нисходящее те- стирование З 4. Методы и средства разработки технической документации Наличие титульного листа, постановки задачи, спецификаций, перечня входных и выходных данных, блок-схемы, сценария отладки программы, инструкции пользователя. 29 Контрольные вопросы: 1. Что включает в себя программная документация? 2. Какие сведения содержит техническое задание 3. Какие сведения содержит текст программы 4. Какие сведения содержит описание 5. Какие сведения содержит пояснительная записка 6. Что относится к эксплуатационным документам 7. Из каких разделов состоит руководство программиста 8. Из каких разделов состоит руководство оператора Практическая работа № 13-15 Разработка руководства программиста Цель работы: Ознакомиться с правилами написания руководства про- граммиста и научиться применять их при написании данного руководства. Оснащение: OS Windows, MS Office. Формируемые компетенции: ОК-2 ОК-3 ОК-4 ОК-5 ОК-6 ОК-7 ОК-8 ОК-9 ПК-3.1 ПК- 3.2 ПК-3.3 ПК-3.4 ПК- 3.5 ПК-3.6 Теоретическая часть Руководство программиста разрабатывают в трех случаях: 1) программный продукт по своему основному назначению является средой разработки или библиотекой (как Delphi или Qt); 2) комплекс или программный продукт служит платформой для разра- ботки программ или систем определенного типа (как 1С или Axapta); 3) программа распространяется вместе с исходным кодом или постоянно модифицируется самими разработчиками. Наверняка можно представить себе и другие ситуации (например, про- граммный продукт является операционной системой), но в жизни они встреча- ются значительно реже. Очевидная задача руководства программиста — снабдить разработчика информацией, которой ему будет достаточно для создания на базе нашего про- граммного продукта собственных программ или систем. Еще один мотив со- здания такого документа — потребность разработчиков время от времени фик- сировать состояние продукта, чтобы самим в нем не запутаться и не плодить в коллективе носителей «сакральных знаний». Методика и стиль изложения Важнейшие методические требования к теоретической части руководства программиста — логичность и последовательность изложения. В частности, в тексте обязательно должны быть соблюдены следующие правила: 30 1) При вводе нового понятия мы опираемся только на те понятия, кото- рые были введены ранее явно или считаются заведомо знакомыми читателю. Как в учебнике математики. 2) У читателя никогда не должно возникать ощущение, что автор плодит сущности без надобности. Ввод каждого понятия должен быть чем-то обосно- ван. Основное требование при описании отдельных объектов — полнота опи- сания каждого из них. В отличие от руководства пользователя, при составлении которого в принципе можно рассчитывать на догадливость читателя, который поглядит на интерфейс и сам разберется, руководство программиста описывает весьма неочевидные вещи. И хотя от программиста можно ожидать большей догадливости, чем от пользователя, восполнять недостаток информации ему придется анализом исходного текста, а если он доступен, то тестированием «черного ящика» и отладчиком. При описании объектов особое внимание следует уделять следующим ас- пектам: 1) Что обязательно должно предшествовать созданию и использованию объекта. 2) Каковы побочные эффекты обращения к объекту. 3) Особенности интерпретации объектом передаваемых ему данных. 4) Где «физически» (в каком файле, в какой библиотеке) находится объ- ект. 5) Желательно по каждому объекту привести примеры использования, небольшие фрагменты кода, демонстрирующие: 6) создание объекта (если перед использованием его необходимо со- здать); 7) передачу объекту входных данных; 8) получение выходных данных и их интерпретацию. 9) Описания объектов можно вынести в отдельный том или документ под названием «Справочник программиста». Хорошая мысль — сделать его ги- пертекстовым. Между теоретической частью и справочником по объектам полезно поме- стить небольшой раздел, в котором рассматривается пример небольшого, но полноценного, с точки зрения используемой платформы, приложения. Пример должен быть таким, чтобы читатель смог самостоятельно это приложение вос- произвести, отладить и запустить. Очевидно, для этого сначала все это должен проделать кто-то из авторов руководства программиста. Пример «Руководство программиста» представлен в приложении А Практическая часть Оформить отчет как в приложении Б Сделать выводы по работе 31 СПИСОК ОСНОВНЫХ ЛИТЕРАТУРНЫХ ИСТОЧНИКОВ 1. Федеральный государственный образовательный стандарт среднего профессионального образования по специальности 09.02.03 Программирование в компьютерных системах (Приказ Министерства образования и науки РФ от 28 июля 2014. № 804 " Об утверждении федерального государственного обра- зовательного стандарта среднего профессионального образования по специ- альности 09.02.03 Программирование в компьютерных системах). БИБЛИОГРАФИЧЕСКИЙ СПИСОК Перечень ресурсов информационно-телекоммуникационной сети "Интернет" 1. Метрология, стандартизация и сертификация : учеб. пособие / Е.Б. Ге- расимова, Б.И. Герасимов. — 2-е изд. — М. : ФОРУМ : ИНФРА-М, 2018. — 224 с.(11.09.2015).http://znanium.com/catalog/product/922730 2. Метрология, стандартизация, сертификация : учебник / И.П. Кошевая, А.А. Канке. — М. : ИД «ФОРУМ» : ИНФРА- М, 2017. — 415 с. — (Профессио- нальное образование).http://znanium.com/catalog/product/560216 32 ПРИЛОЖЕНИЕ А (обязательное) ФОРМА ТИТУЛЬНОГО ЛИСТА Форма титульного листа МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ ИНСТИТУТ СФЕРЫ ОБСЛУЖИВАНИЯ И ПРЕДПРИНИМАТЕЛЬСТВА (ФИЛИАЛ) ФЕДЕРАЛЬНОГО ГОСУДАРСТВЕННОГО БЮДЖЕТНОГО ОБРАЗОВАТЕЛЬНОГО УЧРЕЖДЕНИЯ ВЫСШЕГО ОБРАЗОВАНИЯ «ДОНСКОЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ» В Г. ШАХТЫ РОСТОВСКОЙ ОБЛАСТИ (ИСОиП (филиал) ДГТУ в г. Шахты) КОЛЛЕДЖ ЭКОНОМИКИ И СЕРВИСА Ж у р н а л п р а к т и ч е с к и х р а б о т по дисциплине "Документирование и сертификация" . Выполнил (подпись) Паршина Т.П. группа КВ 9-412 (инициалы, фамилия, группа) Проверил (подпись) преподаватель Е.Н. Семеренко 33 ПРИЛОЖЕНИЕ Б (обязательное) МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ ИНСТИТУТ СФЕРЫ ОБСЛУЖИВАНИЯ И ПРЕДПРИНИМАТЕЛЬСТВА (ФИЛИАЛ) ФЕДЕ- РАЛЬНОГО ГОСУДАРСТВЕННОГО БЮДЖЕТНОГО ОБРАЗОВАТЕЛЬНОГО УЧРЕЖДЕ- НИЯ ВЫСШЕГО ОБРАЗОВАНИЯ «ДОНСКОЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ» В Г. ШАХТЫ РОСТОВСКОЙ ОБЛАСТИ (ИСОиП (филиал) ДГТУ в г. Шахты) КОЛЛЕДЖ ЭКОНОМИКИ И СЕРВИСА СОГЛАСОВАНО УТВЕРЖДАЮ Руководитель Зам. Директора по УР _____________Г.Д. Диброва ._____________Б.И. Шемет (подпись) (подпись) «____»____________2015г. «____»____________2015г ОПРЕДЕЛЕНИЕ ПОЛОЖЕНИЯ ТОЧКИ РУКОВОДСТВО ПРОГРАММИСТА Руководитель, к.т.н., доцент, преподаватель ___________________ Г.Д. Диброва Исполнитель, студент гр. КВ9-313 ___________________ Д. Винниченко Шахты 34 СОДЕРЖАНИЕ 1. АНОТАЦИЯ 35 1.1. Назначение документ 35 1.2. Краткое изложение основной части документа 35 2. НАЗНАЧЕНИЕ И УСЛОВИЕ ПРИМЕНЕНИЯ ПРОГРАММЫ 35 2.1. Назначение программы 35 2.2. Функции, выполняемые программой 35 2.3. Условия, необходимые для выполнения программы 35 2.3.1. Объем оперативной памяти 35 2.3.2. Требования к составу и параметрам периферийных устройств 36 2.3.3. Требования к программному обеспечению 36 3. ХАРАКТЕРИСТИКА ПРОГРАММЫ 36 3.1. Описание основных характеристик программы 36 3.1.1. Режим работы программы 36 3.1.2. Контроль правильности выполнения программы 36 3.2. Описание основных особенностей программы 36 4. ОБРАЩЕНИЕ К ПРОГРАММЕ 36 4.1. Описание процедур вызова программы 36 5. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ 36 5.1 Описание организации входной и выходной информации 36 5.2. Описание кодирования информации 37 6.СООБЩЕНИЯ 37 6.1. Тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы 37 6.2. Описание содержания сообщений 37 6.3. Описание действий, которые необходимо предпринять по сообщениям39 35 1. АНОТАЦИЯ 1.1. Назначение документа Назначение руководства программиста — снабдить разработчика инфор- мацией, которой ему будет достаточно для создания на базе нашего программ- ного продукта собственных программ или систем. Еще одно назначение такого документа — потребность разработчиков время от времени фиксировать состо- яние продукта, чтобы самим в нем не запутаться и не плодить в коллективе но- сителей «сакральных знаний». 1.2. Краткое изложение основной части документа В основной части документа приведены сведения о назначении, возмож- ностях, условии применения и организации данных системы. Для удобства ра- боты руководство поделено на разделы и подразделы. В разделах, которые опи- сывают возможности системы приведены практические примеры, позволяющие лучше понять и освоить представленную информацию. 2. НАЗНАЧЕНИЕ И УСЛОВИЕ ПРИМЕНЕНИЯ ПРОГРАММЫ 2.1. Назначение программы Разработанная программа «Вычисление суммы бесконечного ряда» должна быть предназначена для определения положения точки в указанной об- ласти. Состав и параметры технических средств, на которых может работать данная программа, должны быть типовыми для компьютерных классов. 2.2. Функции, выполняемые программой Разработанная программа должен выполнять следующие функции: 1) выводить на экранную форму сведения о проекте, его разработчике; 2) выводить на экранную форму исходные данные: начало отрезка, ко- нец отрезка, шаг, варианты погрешностей; 3) выводить на форму результат в виде таблицы, содержащей: значения аргумента, значения функции ch(x), представленной в виде суммы бесконечно- го ряда, значения ch(x), вычисленные с помощью встроенной функции. 4) если исходные данные на форме не внесены или не выбраны, выво- дить соответствующее сообщение; 5) если начало отрезка превышает конец отрезка, выводить соответству- ющее сообщение; 6) запрашивать пользователя о его окончательном решении завершить работу с проектом; 7) иметь доступный и простой интерфейс пользователя; 2.3. Условия, необходимые для выполнения программы 2.3.1. Объем оперативной памяти Для выполнения своих функций, программе «Вычисление суммы беско- нечного ряда» достаточно 1 Мб оперативной памяти. Но, исходя из того, что 36 для функционирования операционной системы необходимо минимум 32 Мб оперативной памяти, то рекомендуется использовать программу на ПК, имею- щем ОЗУ более 32 Мб. 2.3.2. Требования к составу и параметрам периферийных устройств Особых требований к составу и параметрам периферийных устройств, программа «Вычисление суммы бесконечного ряда» не предъявляет. 2.3.3. Требования к программному обеспечению Системные программные средства, используемые программой «Вычисле- ние суммы бесконечного ряда», должны быть представлены локализованной версией операционной системы Windows XP, Windows 7, Windows 8.1 или Windows 10. Программа предназначена для самостоятельного вычисления суммы бес- конечного ряда, поэтому для вычисления нужно запустить программу, ввести нужные данные и программа начнет вычисление. 3. ХАРАКТЕРИСТИКА ПРОГРАММЫ 3.1. Описание основных характеристик программы 3.1.1. Режим работы программы Режим работы программы «Вычисление суммы бесконечного ряда» руч- ной. Данный режим позволяет максимально сберечь память ПК. Программа по- стоянно находится в памяти ПК, но не появляется на панели задач, что позволя- ет экономить ресурсы компьютера. 3.1.2. Контроль правильности выполнения программы Работоспособность программы «Вычисление суммы бесконечного ряда» проверяется с помощью ввода запланированных при разработке программы данных, и если после ввода программа не нашла ошибок, то программа работа- ет правильно. 3.2. Описание основных особенностей программы Программа «Вычисление суммы бесконечного ряда» не имеет пользова- тельского интерфейса и не предоставляет конечному пользователю возможно- сти настройки и изменения своих параметров. 4. ОБРАЩЕНИЕ К ПРОГРАММЕ 4.1. Описание процедур вызова программы Чтобы запустить программу «Вычисление суммы бесконечного ряда» для начала нужно запустить текстовый процессор "Word" или табличный процессор "Excel" с поддержкой макросов (docm и xlsm), после чего нажать сочетание клавиш "Alt+F11". Откроется окно языка программирования VBA (Visual Basic for Application). В нем запускаем программу и делаем вычисления. 5. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ 5.1 Описание организации входной и выходной информации 37 Программа «Вычисление суммы бесконечного ряда» в ходе своей работы использует входные данные такие как начало отрезка, конец отрезка и шаг, и использует выходные данные такие как Х, сумма ряда и гиперболический ко- синус при выборе одной из трех погрешностей. 5.2. Описание кодирования информации Данная программа имеет двоичный способ кодирования информации, так как этот способ на данный момент является самым актуальным. 6.СООБЩЕНИЯ 6.1. Тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы При работе программы «Вычисление суммы бесконечного ряда» могут появиться сообщения, показанные на рисунке 1. Рисунок 1 - Сообщение об ошибке в работе программы 6.2. Описание содержания сообщений Первое сообщение появляется только в том случае, если пользователь не ввел в поле ввода данные. Второе сообщение появляется, если пользователь ввел начало отрезка больше, чем конец отрезка. И третье сообщение появляет- ся, если пользователь не выбрал погрешность. 6.3. Описание действий, которые необходимо предпринять по со- общениям Если вышло первое сообщение, то надо ввести все параметры в програм- му. Если вышло второе сообщение, то нужно ввести правильно начало и конец отрезка. Если вышло третье сообщение, то надо выбрать погрешность. Вывод: В данной практической работе были изучены правила написания руко- водства программиста. Список литературных источников 1. ГОСТ 19.106-78. Единая система программной документации. Требования к программным документам, выполненным печатным способом. 2. ГОСТ 19.105-78. Общие требования к программным документам. 3. ГОСТ 19.504-79. Руководство программиста. Требования к содержанию и оформлению. 38 ПРИЛОЖЕНИЕ В (обязательное) ПРИМЕР ОФОРМЛЕНИЯ ПЕРВОЙ СТРАНИЦЫ ОТЧЕТА Пример оформления первой страницы отчета |