Подраздел Структура файлов базы данных должен содержать схему взаимосвязи таблиц (файлов) базы данных и/или ER-модель (модель «сущность — связь»).
Структура файла может быть описана следующим образом:
а) наименование и назначение файла;
б) обозначение файла (латиница);
в) перечень реквизитов (атрибутов) в порядке их следования в записях, с указанием по каждому реквизиту: наименования атрибута; обозначения атрибута (латиница); длины в знаках и диапазоны изменения (при необходимости); логических и семантических связей с другими реквизитами данного файла (отношения) или других; и т. д.
Перечень и структура файла могут быть описаны, например, в виде таблицы 1.
Таблица 1 — Структура файла «Gard.gdb»
| Идентификатор поля | Тип поля | Длина поля | Описание поля |
| . |
Подраздел Структура программных модулей должен содержать схему схема взаимосвязи программных модулей с указанием названий и кратким описанием функций каждого модуля.
Вывод информации из базы данных. Label. Создание десктопного приложения с помощью Tkinter #3
Рабочий проект
Этот раздел должен содержать подразделы: Алгоритм решения задачи, Описание программы, Контрольный пример, Руководство оператора (пользователя), Руководство программиста.
Алгоритм решения задачи
Подраздел раздела Рабочий проект должен содержать описание алгоритма решения задачи в виде функциональной блок-схемы алгоритма и текстовое описание блоков функциональной схемы с указанием используемых в них значимых конструкций языка программирования (функций, операторов, типов данных). Для особо значимых функций, модулей, блоков программы, методов может быть представлена детальная блок-схема алгоритма решения задачи и текстовое описание блоков схемы.
В случае разработки (поддержки, эксплуатации, модернизации) сайта (информационного портала) данный подраздел должен содержать модель событий и обмена данными с текстовым описанием блоков и потоков обмена данными.
Описание стандартных символов блок-схемы алгоритма должно соответствовать правилам ЕСПД (ГОСТ 19.002-80 и 19.003-80).
Описание программы
Содержание программного документа «Описание программы» определенно ГОСТ 19.101-77. В соответствии с этим подраздел Описание программы раздела Рабочий проект должен содержать:
— описание логической структуры;
— используемые технические средства;
— вызов и загрузка;
При создании большой программной системы или составлении программы для решения какой-то конкретной задачи в пунктах «общие сведения» и «функциональное назначение» следует отразить, следующие сведения о программе:
— наименование и назначение разрабатываемой программы. Нужна ли она временно или будет использоваться постоянно, планируется ли передавать, другим организациям, будут ли разрабатываться ее новые версии.
— язык программирования, используемый для составления программы. Чем продиктован выбор языка программирования (доступностью того или иного транслятора или другими факторами);
Как сделать курсовую»базу данных» в консольном приложение на с++ (Шаблон №1 – Файлы и функции)
— размер программы (размер в байтах, количество отдельных модулей программы);
— основные типы данных, с которыми придется иметь дело (количество файлов данных, типы файлов данных);
— характер и уровень использования аппаратных, средств — центральных и периферийных.
В пункте «описание логической структуры» должны быть указаны:
— структура программы с описанием функций составных частей и связи между ними;
— связи программы с другими программами.
В пункте «используемые технические средства» должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы.
В пункте «вызов и загрузка» должны быть указаны:
— способ вызова программы с соответствующего носителя данных;
— входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
В пункте «входные данные» должны быть указаны:
— характер, организация и предварительная подготовка входных данных;
— формат, описание и способ кодирования входных данных.
В пункте «выходные данные» должны быть указаны:
— характер и организация выходных данных;
— формат, описание и способы кодирования выходных данных.
Содержание всех этих пунктов можно иллюстрировать пояснительными примерами, таблицами, схемами, графиками, распечатками пунктов меню и т.п.
В приложении к описанию программы допускается включать личные материалы, которые, нецелесообразно включать в само описание (например, те же распечатки пунктов меню, подменю и др.)
4.5.2.3 Контрольный пример
Подраздел Контрольный пример — документ, позволяющий осуществить полную проверку функционирования разработанного программного обеспечения.
Подраздел Контрольный пример должен включать следующие пункты:
— назначение, основные функции;
В «назначении» должны содержаться перечень параметров и краткая характеристика функций, проверяемых с помощью контрольного примера.
Пункты «исходные данные» и «результаты расчета» должны включать соответственно описания исходных и результатных данных для проверки программы (комплекса программ) и сами эти данные (данные можно разместить всоответствующие приложения).
Заключительный пункт «проверка программы» должен содержать описания процедур формирования исходных данных, вызова проверяемой программы и получения результатов расчета, а также инструкции для работы оператора (пользователя) при подготовке исходных данных и в процессе проверки программного комплекса.
Процесс проверки функционирования программы должен сопровождаться рисунками и подробными описаниями действий программы.
4.5.2.4 Руководство оператора (пользователя)
Структура и оформление программного документа «Руководство оператора (пользователя)» устанавливаются в соответствии с ГOCT 19.105 — 78. Руководство оператора должно содержать:
— сведения о назначении программы и информацию, достаточную для понимания функций программы и ее эксплуатации;
— условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратных и программных средств и т. п.);
— последовательность действий пользователя, обеспечивающих загрузку, запуск, выполнение и завершение программы; описание функций, возможных вариантов команд, с помощью которых пользователь осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды;
— тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия пользователя (в случае сбоя, возможности повторного запуска программы).
Руководство программиста
Структура и оформление программного документа «Руководство программиста» устанавливаются в соответствии с ГOCT 19.504 — 79. Руководство программиста должно содержать следующие разделы:
— назначение и условия применения программ;
— обращение к программе;
— входные и выходные данные;
В разделе “назначение и условия применения программ” должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программного обеспечению и т.п.).
В разделе “характеристика программы” должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В разделе “обращение к программе” должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
В разделе “входные и выходные данные” должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.
В разделе “сообщения” должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
Источник: cyberpedia.su
Программная документация. Требования Единой системы программной документации. Привести примеры программных документов
Содержание и оформление работы должны отвечать следующим шести требованиям:
1. Общим требованиям к программным документам.
Общие требования к оформлению программных документов устанавливает ГОСТ 19.105-78.
Программный документ может подаваться на различных типах носителей данных и состоять из следующих условных частей:
Титульная часть состоит из листа утверждения и титульного листа согласно ГОСТ 19.104-78.
Информационная часть состоит из аннотации и содержания. В аннотации указывают сведения о назначении документа и сжатое изложение его основной части.
Содержание содержит перечень записей о структурных элементах основной части документа, в каждую из которых входят:
– обозначения структурного элемента (номер раздела, подраздела);
– наименование структурного элемента;
– адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.д.).
Правила обозначения структурных элементов основной части документа и их адресации устанавливают стандарты ЕСПД для каждого типа носителя. Состав и структуру основной части программного документа устанавливают правила ЕСПД на соответствующие документы. О каждом изменении программного документа делают запись согласно ГОСТ 19.603-78.
2. Требованиям к описанию языка.
Требования к содержанию и оформлению программного документа по описанию языка (программирование, управление заданием, организация вычислительного процесса) устанавливает ГОСТ 19.506-79. При этом учитываются положения ГОСТ 19.105-78 «Общие требования к программным документам». Составление информационной части (аннотации и содержания) является обязательным.
Описание языка должно содержать следующие разделы.
1. Общие сведения. Указывают назначение и дают описание общих характеристик языка, его возможностей, основных сфер использования и т.д.
2. Элементы языка. Дают описание синтаксиса и семантики базовых и составляющих элементов языка.
3. Способы структурирования программы. Указывают способы вызова процедуры, передачи управления и другие элементы структурирования программы.
4. Средства обмена данными. Указывают описание Языковых средств обмена данными (например, средства ввода-вывода, внутреннего обмена данными и т.д.).
5. Встроенные элементы. Дают описание встроенных в язык элементов (например, функции, классы и т.д.) и правила их использования.
6. Средства отладки программ. Указывают описание наличных средств отладки программ, семантику этих средств, рекомендации относительно их использования.
3. Требованиям к тексту и описанию программы.
Структуру и оформление текста программы устанавливают в соответствии с ГОСТ 19.105-78 «Общие требования к программным документам». Составление информационной части (аннотации и содержания) является обязательным.
Основная часть документа должна состоять из текстов, одного или нескольких разделов, которым дают наименование. Каждый из этих разделов реализуется одним из типов символической записи, например:
– символические записи исходными или промежуточными языками;
– символическое представление машинных кодов и т.д.
В символическую запись разделов рекомендуется включать комментарии, которые могут отображать, например, функциональное ‘назначение, структуру (ГОСТ 19.401-78).
Описание программы должно содержать следующие разделы (ГОСТ 19.402-78):
1. Общие сведения. Указывают обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; язык программирования, которым написана программа.
2. Функциональное назначение. Указывают классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях программы.
3. Описание логической структуры. Указывают алгоритм программы, использованные методы, структуру программы с описанием функций составляющих частей и связи между ними. Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
4. Использованные технические средства. Перечисляют типы ЭВМ и устройства, используемые для работы программы.
5. Вызов и загрузка. Указывают способ вызова программы с соответствующего носителя данных, входные точки программы. Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
6. Входные данные. Указывают характер, организацию и предварительную подготовку входных данных, а также формат и способ кодирования входных данных.
7. Выходные данные. Указывают характер и организацию выходных данных, а также формат и способ кодирования выходных данных.
4. Требования к пособию системного программиста.
Требования к содержанию и оформлению программного документа «Пособие системного программиста» устанавливает ГОСТ 19.563-79. При этом учитываются положения ГОСТ 19.105-78 «Общие требования к программным документам». Составление информационной части (аннотации и содержания) является обязательным.
Пособие системного программиста должно содержать следующие разделы.
1. Общие сведения о программе. Указывают назначение и функции программы и сведения о технических и программных средствах, которые обеспечивают выполнение этой программы.
2. Структура программы. Указывают сведения о структуре программы, ее составные части и связи между ними и другими программами.
3. Настройка программы. Указывают описание действий по настройке программы на условия конкретного использования (настройка на состав технических средств, выбор функций и др.).
4. Проверка программы. Указывают описание способов проверки, позволяющие оценить работоспособность программы (контрольные примеры, методы прогона, результаты).
5. Сообщения системному программисту. Указывают тексты сообщений, выдаваемых в ходе выполнения настройки и т.п.
В приложениях к пособию можно указывать вспомогательные материалы (примеры, иллюстрации, таблицы, графики и т.д.).
5. Требования к пособию программиста.
Пособие программиста должно содержать следующие разделы.
1. Назначение и условия использования программы. Указывают назначение и функции, которые должна выполнять программа, и условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, программного обеспечения и т.д.).
2. Характеристика программы. Описывают основные характеристики и особенности программы (временные характеристики, режим работы, средств контроля и т.д.).
3. Обращение к программе. Указывают описание процедур вызова программы (способы передачи управления и параметров данных и т.д.).
4. Входные и выходные данные. Представляют описание организации используемой входной и выходной информации.
5. Сообщения. Указывают пакеты сообщений, выдаваемые программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо выполнять по этим сообщениям.
В приложениях можно указывать вспомогательные материалы (примеры, иллюстрации, таблицы, графики и т.д.).
6. Требования к ТЗ.
Порядок построения и оформления ТЗ на разработку программы или программного изделия устанавливает ГОСТ 19.201-78.
Техническое задание содержит следующие разделы.
1. Вступление. Указывают наименование, сжато характеризуют сферу использования программы (изделия) и объекта.
2. Основания для разработки.
В этом разделе указывают:
– документ, на основании которого выполняется разработка;
– организации, утвердившие этот документ;
– наименование и (или) условное обозначение цели разработки.
3. Назначение разработки. Указывают функциональное и эксплуатационное назначение программы (изделия).
4. Требования к программе или программному изделию.
Этот раздел состоит из следующих подразделов:
– требования к функциональным характеристикам и надежности;
– требования к составу и параметрам технических средств, их информационной и программной совместимости;
– условия эксплуатации, специальные требования.
5. Требования к программной документации. Указывают предварительный состав программной документации и, в случае необходимости, специальные требования к ней.
6. Технико-экономические показатели.
В этом разделе указывают:
– ориентировочную экономическую эффективность;
– предусмотренную потребность на год;
– экономические преимущества в сравнении с лучшими образцами (аналогами).
8. Порядок контроля и приемки. Указывают виды испытаний и общие требования к приемке работ.
В приложениях к ТЗ в случае необходимости указывают:
– перечень научно-исследовательских и других источников и работ, обосновывающих разработку;
– схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы в разработке.
Воспользуйтесь поиском по сайту:
studopedia.org — Студопедия.Орг — 2014-2023 год. Студопедия не является автором материалов, которые размещены. Но предоставляет возможность бесплатного использования (0.011 с) .
Источник: studopedia.org