Содержание программного документа «Описание программы» определенно ГОСТ 19.101-77. В соответствии с этим подраздел Описание программы раздела Рабочий проект должен содержать:
— описание логической структуры;
— используемые технические средства;
— вызов и загрузка;
При создании большой программной системы или составлении программы для решения какой-то конкретной задачи в пунктах «общие сведения» и «функциональное назначение» следует отразить, следующие сведения о программе:
— наименование и назначение разрабатываемой программы. Нужна ли она временно или будет использоваться постоянно, планируется ли передавать, другим организациям, будут ли разрабатываться ее новые версии.
— язык программирования, используемый для составления программы. Чем продиктован выбор языка программирования (доступностью того или иного транслятора или другими факторами);
— размер программы (размер в байтах, количество отдельных модулей программы);
Описание и пример работы с документами
— основные типы данных, с которыми придется иметь дело (количество файлов данных, типы файлов данных);
— характер и уровень использования аппаратных, средств — центральных и периферийных.
В пункте «описание логической структуры» должны быть указаны:
— структура программы с описанием функций составных частей и связи между ними;
— связи программы с другими программами.
В пункте «используемые технические средства» должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы.
В пункте «вызов и загрузка» должны быть указаны:
— способ вызова программы с соответствующего носителя данных;
— входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
В пункте «входные данные» должны быть указаны:
— характер, организация и предварительная подготовка входных данных;
— формат, описание и способ кодирования входных данных.
В пункте «выходные данные» должны быть указаны:
— характер и организация выходных данных;
— формат, описание и способы кодирования выходных данных.
Содержание всех этих пунктов можно иллюстрировать пояснительными примерами, таблицами, схемами, графиками, распечатками пунктов меню и т.п.
В приложении к описанию программы допускается включать личные материалы, которые, нецелесообразно включать в само описание (например, те же распечатки пунктов меню, подменю и др.)
Воспользуйтесь поиском по сайту:
studopedia.org — Студопедия.Орг — 2014-2023 год. Студопедия не является автором материалов, которые размещены. Но предоставляет возможность бесплатного использования (0.009 с) .
Источник: studopedia.org
API для начинающих. Пример VK. [1/5]
Алгоритмизация. Лабораторные работы / Лабораторная работа №5.1 / Образец_описания_программы
Программа именуется «Перестановка блоков матрицы». Для нормального функционирования программы необходимо следующее программное обеспечение:
операционная система MS-DOS;
пакет программ Borland C++ver.3.1.
Программа написана на языке высокого уровня Си.
2 Функциональное назначение
Программа предназначена для создания новой действительной матрицы из заданной, путем перестановки блоков исходной матрицы в порядке указанном на рисунке 1.
- порядок матрицы необходимо задавать как целое, положительное число меньшее 5 (05);
- элементами матрицы являются действительные положительные числа из диапазона 0
a[i][j]
3 Описание логической структуры Описание логической структуры программы представлено схемой алгоритма. Схема алгоритма функции main(). 
/Все блоки в схеме алгоритма необходимо пронумеровать арабскими цифрами в порядке сверху вниз и слева направо/
5)». Пользователю необходимо набрать желаемое значение порядка матрицы на клавиатуре и завершить ввод нажатием клавиши . После этого на экране появится матрица порядка 2n. Элементами этой матрицы будут случайные числа из диапазона от 0 до 100 (a[i][j]=random(100)). Это исходная матрица. Ниже на экране появится сообщение: «Новая матрица:», под которым и будет располагаться матрица с перестановленными по схеме блоками. 4 Используемые технические средства Для создания программы использовался компьютер на платформе ЭВМ IBM PC, с процессором Intel Pentium, тактовой частотой 166Гц, оперативной памятью 16Мб, под управлением операционной системы Windows95. 5 Вызов и загрузка Для загрузки данной программой необходимо запустить файл «youlori.cpp» из среды Borland C.На экране появится текст программы. Для запуска программы на исполнение пользователю необходимо нажать комбинацию клавиш Ctrl+F9. Вызов программы производится с жесткого диска. Объем программы составляет 526 байт. 6 Входные данные Входными данными являются: матрица действительных элементов a[ ][ ] (тип float); целая переменная n (тип int) – порядок матрицы, деленный на два. 7 Выходные данные Выходными данными является матрица действительных чисел a[ ][ ] (тип float), блоки которой переставлены в соответствии с условием задачи. 8 Контрольный пример Пусть порядок матрицы n= 3. Вид исходной матрицы приведен на рисунке 2.
| 1 | 11 | 9 | 40 | 49 | 83 |
| 76 | 54 | 33 | 81 | 3 | 35 |
| 17 | 17 | 2 | 97 | 67 | 13 |
| 93 | 41 | 72 | 31 | 80 | 91 |
| 5 | 15 | 90 | 4 | 30 | 26 |
| 52 | 86 | 10 | 8 | 79 | 20 |
Рисунок 2 – Исходная матрица Следовательно, переставляя ее блоки по схеме (см. рисунок 1) получим новую матрицу, представленную на рисунке 3.
| 52 | 86 | 10 | 8 | 79 | 20 |
| 26 | 15 | 90 | 4 | 30 | 5 |
| 91 | 80 | 72 | 31 | 41 | 93 |
| 13 | 67 | 2 | 97 | 17 | 17 |
| 35 | 54 | 33 | 81 | 3 | 76 |
| 1 | 11 | 9 | 40 | 49 | 83 |
Рисунок 3 – Результирующая матрица Результат выполнения программы аналогичен. Листы нумеруются на каждой странице за исключением титульного листа
Источник: studfile.net
Документ «Описание программного обеспечения»
РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: .
УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.
Описание программного обеспечения
- Структура документа:
ВВЕДЕНИЕ
УКАЗАНИЯ ГОСТ:
Во вводной части приводят основные сведения о техническом, информационном и других видах обеспечения АС, необходимые для разработки программного обеспечения или ссылку на соответствующие документы проекта АС.
ПРИМЕР СОДЕРЖАНИЯ:
АИС «Кадры» предназначена для комплексного информационно-аналитического обеспечения процессов федерального агентства «Государственные Кадры», в части исполнения следующих процессов:
.
.
.
Сведения о техническом обеспечении АС Кадры приведены в пояснительной записке к техническому проекту (п.3.8).
Сведения об информационном обеспечении АС Кадры приведены в документе «Описание информационного обеспечения системы».
1 СТРУКТУРА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
УКАЗАНИЯ ГОСТ:
В разделе «Структура программного обеспечения» приводят перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение этого раздела можно взять в ТЗ, пункте «4.1.1.1 Перечень подсистем, их назначение и основные характеристики».
Содержание необходимо переписать в императиве (не «В состав АС Кадры должны входить следующие подсистемы», а «В состав АС Кадры входят следующие подсистемы»).
2 ФУНКЦИИ ЧАСТЕЙ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
УКАЗАНИЯ ГОСТ:
В разделе «Функции частей программного обеспечения» приводят назначение и описание основных функций для каждой части программного обеспечения.
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение этого раздела можно взять в ТЗ, пункте «4.2 Требования к функциям (задачам), выполняемым системой».
Содержание необходимо переписать в императиве (не «Модуль должен реализовывать следующие функции», а «Модуль реализует следующие функции»).
3 МЕТОДЫ И СРЕДСТВА РАЗРАБОТКИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
УКАЗАНИЯ ГОСТ:
В разделе «Методы и средства разработки программного обеспечения» приводят перечень методов программирования и средств разработки программного обеспечения АС с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
ПРИМЕР СОДЕРЖАНИЯ:
Проектирование модели предметной области АС «Кадры» выполнялось с использованием программного средства Rational Rose Enterprise Edition.
Проектирование структур баз данных АС «Кадры» выполнялось с использованием программного средства Microsoft Visio 2003 Enterprise Architect.
Создание программного обеспечения АС «Кадры» и создание установочных пакетов выполнялось с помощью среды разработки Microsoft Visual Studio 2005 Team Server.
Управление изменениями требований к АС «Кадры» выполнялось с помощью программного средства Rational Rose RequisitePro.
4 ОПЕРАЦИОННАЯ СИСТЕМА
УКАЗАНИЯ ГОСТ:
В разделе «Операционная система» указывают:
1) наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии;
2) наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы;
3) требования к варианту генерации выбранной версии операционной системы.
ПРИМЕР СОДЕРЖАНИЯ:
Для выделенного сервера баз данных АС «Кадры» могут быть использованы следующие операционные системы:
— Microsoft Windows 2000 Server SP4;
— Microsoft Windows 2003 Server SP2.
Предпочтительным является использование операционной системы Microsoft Windows 2003 Server SP2.
Для клиентской части программного обеспечения АС «Кадры» могут быть использованы следующие операционные системы:
— Microsoft Windows 2000 Professional SP4;
— Microsoft Windows XP Professional SP2.
Предпочтительным является использование операционной системы Microsoft Windows XP Professional SP2.
5 СРЕДСТВА, РАСШИРЯЮЩИЕ ВОЗМОЖНОСТИ ОПЕРАЦИОННОЙ СИСТЕМЫ
ПРИМЕР СОДЕРЖАНИЯ:
В состав программного обеспечения АС «Кадры» не входят средства, расширяющие возможности операционной системы.
ПРИМЕР СОДЕРЖАНИЯ:
В состав программного обеспечения АС «Кадры» входят следующие средства, расширяющие возможности операционной системы:
— Программная библиотека доступа к функциям сервера СУБД.
5.1 Наименование и краткая характеристика средства
ПРИМЕР СОДЕРЖАНИЯ:
Библиотека доступа «БДУправ 1.0».
5.2 Руководство по настройке средства
ПРИМЕР СОДЕРЖАНИЯ:
Настройка не производится.
5.3 Требования по настройке средства
ПРИМЕР СОДЕРЖАНИЯ:
Требования по настройке средства не предъявляются.
ГОСТы
- Классификаторы ЕСКД
- Перечень стандартов
- ГОСТ 2.xxx (ЕСКД)
- ГОСТ 6.ххх (УСД)
- ГОСТ 15.ххх
- ГОСТ 19.xxx (ЕСПД)
- ГОСТ 24.xxx (ЕСС АСУ)
- ГОСТ 34.ххх
Источник: www.rugost.com