- •Череповец
- •В ведение
- •Раздел 1 Техническое задание
- •Раздел 2 расчетно-пояснительнАя запискА
- •Раздел 3 Руководство пользователя
- •Раздел 4 Основные правила оформления программной документации
- •4.1. Оформление текстового материала
- •4.2. Оформление графического материала
- •4.3. Оформление приложений
- •4.4. Оформление списка литературы
- •Рекомендуемая литература
- •Содержание
Раздел 2 расчетно-пояснительнАя запискА
Для оформления пояснительной записки необходимо внимательно изучить ГОСТ 7.32-91 (ИСО 5966-82) «Отчет по научно-исследовательской работе. Структура и правила оформления». В соответствии с этим стандартом пояснительная записка включает в себя:
титульный лист (см. Приложение 2);
аннотацию;
оглавление;
введение;
основную часть;
заключение;
список литературы;
приложения.
Титульный лист оформляют в соответствии с ГОСТ 19.104—78 «Единая система программной документации. Основные надписи».
На второй странице располагается аннотация на разрабатываемое ПО. Аннотация в сжатом виде содержит сведения о количестве листов документа, иллюстраций, таблиц, приложений, а также цели работы, перечень основных терминов и особенности разработки программного продукта.
На третьей странице располагается оглавление, включающее в себя: введение, наименование всех разделов, подразделов, пунктов, заключение, список литературы, перечень приложений с указанием номеров страниц.
На четвертой странице и далее следуют введение и основная часть.
Основная часть содержит следующие разделы:
общие сведения;
функциональное назначение;
описание логической структуры;
используемые технические средства;
вызов и загрузка;
входные данные;
выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
В разделе «Общие сведения» указываются обозначение и наименование программы, а также программное обеспечение, необходимое для функционирования программы и язык программирования, на котором написана программа.
В разделе «Функциональное назначение» указываются классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
В разделе «Описание логической структуры» указываются: алгоритм программы, используемые методы, структура программы с описанием функций составных частей и связи между ними, связи программы с другими программами. Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
В разделе «Используемые технические средства» указываются типы электронно-вычислительных машин и устройств, которые используются при работе программы.
В разделе «Вызов и загрузка» указывается способ вызова программы с соответствующего носителя данных, а также входные точки в программу. Можно указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
В разделе «Входные данные» указываются характер, организация и предварительная подготовка входных данных, а также формат, описание и способ кодирования входных данных.
В разделе «Выходные данные» указываются характер и организация выходных данных, а также формат, описание и способ кодирования выходных данных.
Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
После заключения, в котором в краткой форме излагаются выводы о проделанной работе, результатах исследования в данной проблемной области, следуют список литературы и приложения, где содержится материал, не вошедший в пояснительную записку, но представляющий определенный интерес для более глубокого понимания материала (например, техническое задание - ГОСТ 19.201-78, схемы алгоритмов и программ – ГОСТ 19.002-80, программа и методика испытаний - ГОСТ 19.301-79, текст программы – ГОСТ 19.401-78, руководство пользователя).
В приложении 3 приведен пример оглавления расчетно-пояснительной записки к курсовому проекту по дисциплине «Технология разработки программного обеспечения».