Разработка программ и программной документации регламентируется стандартами ЕСПД вне зависимости от назначения и области их применения.
Виды программных документов, разрабатываемых на разных стадиях проектирования, и их коды, в соответствии с ГОСТ 19.101, приведены в таблице 7.1.
Компонент — это программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса.
Комплекс — это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции.
Таблица 7.1 — Виды программных документов по ГОСТ 19.101
Ø — документ обязательный;
• — документ обязательный для компонентов, имеющих самостоятельное применение;
О — необходимость составления документа определяется на этапе разработки и утверждения ТЗ;
— — документ не составляют.
Каждый программный документ должен состоять из следующих условных частей:
Структура обозначения программ и программных документов установлена ГОСТ 19.103.
Обновление содержания и методик преподавания предметов социально — гуманитарного общего образования
Требования к программным документам, выполняемым печатным способом, даны в ГОСТ 19.106, а к тексту программы — в ГОСТ 19.401.
Титульная часть программного документа состоит из листа утверждения (ЛУ) и титульного листа (ТЛ), выполняемых на бумаге формата А4. Формы ЛУ и ТЛ регламентированы ГОСТ 19.104.
Основная часть программного документа содержит текст документа (с наименованием разделов), рисунки, таблицы и т. п. В основную часть включают: перечень терминов и определений, перечень сокращений, приложения, предметный указатель и перечень ссылочных документов. Оформление основной части программного документа регламентировано в ГОСТ 19.105.
Часть регистрации изменений фиксирует внесение (удаление) нового изменения. Оформление регламентирует ГОСТ 19.603.
Структура обозначения программы и ее программного документа — спецификации по ГОСТ 19.103 следующая:
где А — код страны;
В — код организации разработчика;
ХХХХХ — регистрационный номер в соответствии с классификатором программ;
XX — номер издания программы.
К вышеуказанному обозначению добавляются дополнительные цифры:
XX — код вида документации;
XX — номер документа данного вида;
X — номер части документа, если они есть.
Программная документация в ДП (ДР) в учебном заведении может быть оформлена следующим образом:
• полностью в соответствии с требованиями стандартов ЕСПД, т. е. оформляется как отдельная часть или раздел пояснительной записки;
• включением в ПЗ отдельных программных документов, например, схемы алгоритма программы, текста программы и выполненные, в соответствии с требованиями стандартов ЕСПД, включаются в ПЗ в виде приложений и иллюстраций (рисунки).
В случае использования разработанного ранее программного средства вместо описания программы в проекте должно быть приведено описание возможностей данного программного средства и технологии его использования, оформленное как документ.
Этапы разработки программ
Выполнение и оформление составных частей регламентируются следующими стандартами.
ГОСТ 19.103 устанавливает структуру обозначения программ и программных документов;
ГОСТ 19.104 устанавливает правила оформления титульной части программного документа;
ГОСТ 19.105 устанавливает правила оформления информационной и основной части программного документа;
ГОСТ 19.106 устанавливает требования к программным документам, выполняемым печатным способом;
ГОСТ 19.603 регламентирует оформление регистрации изменений в программном документе;
ГОСТ 19.701 (взамен ГОСТ 19.002 и ГОСТ 19.003) устанавливает в соответствии с международным стандартом ICO 5807-85 правила применения условных обозначений для схем: данных, программ, работы системы, взаимодействия программ и ресурсов системы.
Каждый программный документ по составу и структуре оформляется в соответствии с требованиями конкретного стандарта ЕСПД. Например,
ГОСТ 19.202 устанавливает форму и порядок основного обязательного документа — спецификации;
ГОСТ 19.401 устанавливает требования к содержанию обязательного программного документа — текст программы,
ГОСТ 19.402 устанавливает требования к программному документу — описание программы;
ГОСТ 19.404 устанавливает требования к содержанию программного документа — пояснительной записки.
Допускается внутривузовское обозначение программных документов.
В ПГАТИ принята следующая структура обозначения программных документов:
где ХХХХХХ — специальность и кафедра, например 2007 и индекс кафедры 34;
XXX — порядковый регистрационный номер документа;
XX — код документа (см. таблицу 7.1 пособия).
Устанавливаются три способа выполнения программных документов: 1) машинописный (допускается и рукописный); 2) машинный способ (на ЭВМ); 3) типографский.
Каждый программный документ оформляется в соответствии с требованиями стандартов ЕСПД, например: спецификация (ГОСТ 19.202); описание программы (ГОСТ 19.402); пояснительная записка (ГОСТ 19.404) и др.
Аальтернативная стоимость. Кривая производственных возможностей В экономике Буридании есть 100 ед. труда с производительностью 4 м ткани или 2 кг мяса.
Вычисление основной дактилоскопической формулы Вычислением основной дактоформулы обычно занимается следователь. Для этого все десять пальцев разбиваются на пять пар.
Расчетные и графические задания Равновесный объем — это объем, определяемый равенством спроса и предложения.
Кардиналистский и ординалистский подходы Кардиналистский (количественный подход) к анализу полезности основан на представлении о возможности измерения различных благ в условных единицах полезности.
САНИТАРНО-МИКРОБИОЛОГИЧЕСКОЕ ИССЛЕДОВАНИЕ ВОДЫ, ВОЗДУХА И ПОЧВЫ Цель занятия.Ознакомить студентов с основными методами и показателями.
Меры безопасности при обращении с оружием и боеприпасами 64. Получение (сдача) оружия и боеприпасов для проведения стрельб осуществляется в установленном порядке[1]. 65. Безопасность при проведении стрельб обеспечивается.
Весы настольные циферблатные Весы настольные циферблатные РН-10Ц13 (рис.3.1) выпускаются с наибольшими пределами взвешивания 2.
ИГРЫ НА ТАКТИЛЬНОЕ ВЗАИМОДЕЙСТВИЕ Методические рекомендации по проведению игр на тактильное взаимодействие.
Реформы П.А.Столыпина Сегодня уже никто не сомневается в том, что экономическая политика П.
Виды нарушений опорно-двигательного аппарата у детей В общеупотребительном значении нарушение опорно-двигательного аппарата (ОДА) идентифицируется с нарушениями двигательных функций и определенными органическими поражениями (дефектами).
Источник: studopedia.info
Руководство оператора
В соответствии с ГОСТ 19.781-90 программу допускается идентифицировать и применять самостоятельно и/или в составе др.программ. В соответствии с ГОСТом программы подразделяют на компонент и комплекс.
Компонент – это программа, рассматриваемая как единое целое, выполняющее законченную функцию и применяемая самостоятельно им в составе комплекса.
Комплекс – это программа, состоящая из 2х или более компонентов и/или комплексов, выполняющих взаимосвязанные функции и применяемое самостоятельно в составе др.комплекса.
Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
Общие соображения по стилю и содержанию документов
Каждый разрабатываемый документ должен быть четким, логически стройным, убедительным, конкретным и т.д. Изложение должно быть доступным. По мере возможности следует избегать ссылок на источники, без знакомства с которыми дальнейший материал не может быть понят. Ссылки в основном должны служить для более углубленного изучения предмета.
Надо заранее помнить, что работать с документами придется людям разных узких специальностей и разной квалификации: руководители, экономисты, бухгалтера, математики, операторы и т.п. Уже этого списка достаточно понять, что документ, написанный в стиле научной статьи, не выполнит своей задачи.
Полезно использование компьютера для хранения и обработки документации. Тексты документов могут хранится на внешних носителях вместе с текстами программ. Эффективно широкое использование шаблонов или моделей документов.
Например: в виде заготовок титульных листов, отдельных стереотипных частей документации.
Модели документов могут экономить много сил и времени на всех этапах работы с документацией. Сущность такого метода состоит в том, все заголовки и типовые места какого-либо документа заготавливаются заранее путем проведения анализа наилучших образов.
Эффективность шаблонов слагается из экономии труда разработчика и высокого качества документа. Эксплуатационная документация содержит ведения, необходимые для нормального использования всех возможностей, заложенных в программном комплексе. Качественная документация способствует «непотопляемости» разработки при смене состава разработчиков, их болезни, включение в производственный процесс новых людей.
Для того, чтобы документация не запаздывала по срокам, нужно соблюдать важный принцип разработки документации: ее подготовку нельзя откладывать на потом, она должна идти параллельно с продвижением разработки. Соображения о том, что многое придется переделывать в результате доработок неутешительны – переделывать всегда легче, чем писать заново. Тем более, если эта работа будет выполняться постепенно. Качественная документация, разработанная вовремя, служит сокращению трудозатрат на внедрение и некоторой рекламной разработки. В результате этого часто получают распространение не лучшие разработки, а хорошо и своевременно документированные.
Понравилась статья? Добавь ее в закладку (CTRL+D) и не забудь поделиться с друзьями:
Источник: studopedia.ru
ДОКУМЕНТИРОВАНИЕ И СТАДИИ РАЗРАБОТКИ ПРОГРАММЫ
Программа, как правило, разрабатывается не для того, кто является ее автором. Программу необходимо разрабатывать так, чтобы было понятно, как ее запускать, какой метод решения задачи в ней заложен, каковы требования к вводу (выводу) и т.д. Например, если в программной документации не указана размерность вводимых данных, то пользователь будет в большом затруднении при работе с такой программой.
При разработке программной документации нужно придерживаться государственных стандартов, объединенных в Единую систему программной документации (ЕСПД).
Согласно ГОСТ 19.101-77 «Виды программ и программных документов» программы делятся на компоненты и комплексы. Компонент — это программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса. Комплекс — это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Указанный стандарт определяет в качестве программных документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программы. Все документы делятся на две группы: программные (таблица1) и эксплуатационные (таблица 2).
Таблица 1
Вид программного документа | Содержание программного документа |
Спецификация | Состав программы и документации на нее |
Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
Текст программы | Запись программы с необходимыми комментариями |
Описание программы | Сведения о логической структуре и функционировании программы |
Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
Вид документа | Содержание документа |
Ведомость эксплуатационных документов | Перечень эксплуатационных документов на программу |
Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях на применение, минимальной конфигурации технических средств |
Руководство системного программиста | Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения |
Руководство программиста | Сведения для эксплуатации программы |
Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
Описание языка | Описание синтаксиса и семантики языка |
Руководство по техническому обслуживанию | Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
Строгой регламентации перечня документов для каждой программы ГОСТ 19.101—77 не устанавливает, так как сложность программы и условия ее эксплуатации могут варьироваться в таких широких пределах, что невозможно точно указать, какая именно документация должна быть разработана в каждом конкретном случае. По этой причине ГОСТ 19.101-77 допускает объединение отдельных видов эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра).
Рекомендуемый перечень документов, разрабатываемых в процессе выполнения курсовой работы, должен включать:
Программу и методику испытаний (тестирования).
Поскольку вся документация, разрабатываемая в процессе выполнения курсовой работы, должна отвечать требованиям ЕСПД, ниже приводится необходимая часть содержания стандартов.
Общие сведения о ЕСПД
Согласно ГОСТ 19.001—93 «Единая система программной документации. Общие требования», ЕСПД — это комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации.
Регламентация указанных процессов обеспечивает возможность:
— унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;
— снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;
— автоматизации изготовления и хранения программной документации.
Каждый документ должен иметь титульный лист и лист утверждения. Правила их заполнения регламентируются ГОСТ 19.104-78 «Единая система программной документации. Основные надписи».
На титульный лист и лист утверждения выносятся следующие надписи: наименование министерства; наименование документа: обозначение документа; сведения о носителе данных, на котором представлен подлинник; общее количество листов утверждения; объем документа; сведения о разработчике; подпись нормоконтролера; отметка об учете и хранении; сведения об изменениях.
Лист утверждения оформляется на каждый программный документ на листах формата А4 (ГОСТ 2.301—68) независимо от вида документа, который может быть выполнен на любом носителе данных.
Обозначение листа утверждения состоит из обозначения документа, к которому он относится, и через дефис — шифра листа утверждения. Лист утверждения не входит в общее количество листов документа. Лист утверждения хранится на предприятии-держателе подлинника документа. Копии листа утверждения высылают заказчику и головному предприятию.
Программные документы подразделяются в зависимости от способа выполнения и характера применения на подлинники, дубликаты и копии (ГОСТ 2.102—68), предназначенные для разработки, сопровождения и эксплуатации программы.
Титульный лист заполняют по форме и правилам, установленным для листа утверждения.
Правила оформления последующих листов программных документов регламентируется ГОСТ 19.105—78 «Единая система программной документации. Общие требования к программной документации».
Согласно этому стандарту программный документ состоит из следующих условных частей:
Титульная часть состоит из листа утверждения и титульного листа.
Состав и структура основной части программного документа устанавливается другими стандартами ЕСПД (с частью из них мы познакомимся ниже).
Программные документы выполняют на листах формата А4 (ГОСТ 2.306-68).
Материалы программного документа располагают в последовательности: титульная часть:
титульный лист (первый лист документа);
текст документа (с рисунками, таблицами и т. п.);
Источник: megaobuchalka.ru