ВУЗ: Не указан
Категория: Не указан
Дисциплина: Не указана
Добавлен: 20.11.2019
Просмотров: 9488
Скачиваний: 184
•
структура
,
•
настройка
,
•
проверка
,
•
дополнительные
возможности
,
•
сообщения
системному
программисту
.
Раздел
Общие
сведения
о
программе
должен
включать
описание
назначения
и
функций
программы
,
а
также
сведения
о
технических
и
программных
средствах
,
обеспечивающих
выполнение
данной
программы
(
например
,
объем
оперативной
памяти
,
требования
к
составу
и
параметрам
внешних
устройств
,
требования
к
программному
обеспечению
и
т
.
п
.).
В
разделе
Структура
программы
должны
быть
приведены
сведения
о
структуре
программы
,
ее
составных
частях
,
о
связях
между
составными
частями
и
о
связях
с
другими
программами
.
В
разделе
Настройка
программы
должно
быть
приведено
описание
действий
по
настройке
программы
на
условия
практического
применения
.
В
разделе
Проверка
программы
должно
быть
приведено
описание
способов
проверки
работоспособности
программы
,
например
контрольные
примеры
.
В
разделе
Дополнительные
возможности
должно
быть
приведено
описание
дополнительных
возможностей
программы
и
способов
доступа
к
ним
.
В
разделе
Сообщения
системному
программисту
должны
быть
указаны
тексты
сообщений
,
выдаваемых
в
ходе
выполнения
настройки
и
проверки
программы
,
а
также
в
ходе
ее
выполнения
,
описание
их
содержания
и
действий
,
которые
необходимо
предпринять
по
этим
сообщениям
.
11.5.
Основные
правила
оформления
программной
документации
При
оформлении
текстовых
и
графических
материалов
,
входящих
в
программную
документацию
следует
придерживаться
действующих
стандартов
.
Некоторые
положения
этих
стандартов
приведены
ниже
.
Оформление
текстового
и
графического
материала
.
Текстовые
документы
оформляют
на
листах
формата
А
4,
причем
графический
матерная
допускается
представлять
на
листах
формата
A3.
Поля
на
листе
определяют
в
соответствии
с
общими
требованиями
:
левое
-
не
менее
30,
правое
-
не
менее
10,
верхнее
-
не
менее
15,
а
нижнее
-
не
менее
20
мм
.
В
текстовых
редакторах
для
оформления
записки
параметры
страницы
заказывают
в
зависимости
от
устройства
печати
.
При
ручном
оформлении
документов
параметры
страницы
выбирают
из
соображений
удобства
.
Нумерация
всех
страниц
-
сквозная
.
Номер
проставляется
сверху
справа
арабской
цифрой
.
Страницами
считают
,
как
листы
с
текстами
и
рисунками
,
так
и
листы
приложений
.
Первой
страницей
считается
титульный
лист
.
Номер
страницы
на
титульном
листе
не
проставляют
.
Наименование
разделов
пишут
прописными
буквами
в
середине
строки
.
Расстояние
между
заголовками
и
текстом
,
а
также
между
заголовками
раздела
и
подразделов
должно
быть
равно
:
•
при
выполнении
документа
машинописным
способом
-
двум
интервалам
;
•
при
выполнении
рукописным
способом
- 10
мм
;
•
при
использовании
текстовых
редакторов
-
определяется
возможностями
редактора
.
Наименования
подразделов
и
пунктов
следует
размещать
с
абзацного
отступа
и
печатать
вразрядку
с
прописной
буквы
,
не
подчеркивая
и
без
точки
в
конце
.
Расстояние
между
последней
строкой
текста
предыдущего
раздела
и
последующим
заголовком
при
расположении
их
на
одной
странице
должно
быть
равно
:
•
при
выполнении
документа
машинописным
способом
-
трем
интервалам
;
•
при
выполнении
рукописным
способом
-
не
менее
15
мм
;
•
при
использовании
текстовых
редакторов
-
определяется
возможностями
редактора
.
Разделы
и
подразделы
нумеруются
арабскими
цифрами
с
точкой
.
Разделы
должны
иметь
порядковые
номера
1,2,
и
т
.
д
.
Номер
подраздела
включает
номер
раздела
и
порядковый
номер
подраздела
,
входящего
в
данный
раздел
,
разделенные
точкой
.
Например
: 2.1, 3.5.
Ссылки
на
пункты
,
разделы
и
подразделы
указывают
,
используя
порядковый
номер
раздела
или
пункта
,
на
-
пример
, «
в
разд
. 4», «
в
п
. 3.3.4».
Текст
разделов
печатают
через
1,5-2
интервала
.
При
использовании
текстовых
редакторов
высота
букв
и
цифр
должна
быть
не
менее
1,8
мм
(
шрифты
№
11-12).
Перечисления
следует
нумеровать
арабскими
цифрами
со
скобкой
,
например
: 2), 3)
и
т
.
д
. -
с
абзацного
отступа
.
Допускается
выделять
перечисление
простановкой
дефиса
перед
пунктом
текста
или
символом
,
его
заменяющим
,
в
текстовых
редакторах
.
Оформление
рисунков
,
схем
алгоритмов
,
таблиц
и
формул
.
В
соответствии
с
ГОСТ
2.105-79
«
Общие
требования
к
текстовым
документам
»
иллюстрации
(
графики
,
схемы
,
диаграммы
)
могут
быть
приведены
как
в
основном
тексте
,
так
и
в
приложении
.
Все
иллюстрации
именуют
рисунками
.
Все
рисунки
,
таблицы
и
формулы
нумеруют
арабскими
цифрами
последовательно
(
сквозная
нумерация
)
или
в
пределах
раздела
(
относительная
нумерация
).
В
приложении
-
в
пределах
приложения
.
Каждый
рисунок
должен
иметь
подрисуночную
подпись
-
название
,
помещаемую
под
рисунком
,
например
:
Рис
.12.
Форма
окна
основного
меню
На
все
рисунки
,
таблицы
и
формулы
в
записке
должны
быть
ссылки
в
виде
: «(
рис
. 12)»
или
«
форма
окна
основного
меню
приведена
на
рис
. 12».
Если
позволяет
место
,
рисунки
и
таблицы
должны
размещаться
сразу
после
абзаца
,
в
котором
они
упоминаются
в
первый
раз
,
или
как
можно
ближе
к
этому
абзацу
на
следующих
страницах
.
Если
рисунок
занимает
более
одной
страницы
,
на
всех
страницах
,
кроме
первой
,
проставляется
номер
рисунка
и
слово
«
Продолжение
».
Например
:
Рис
. 12.
Продолжение
Рисунки
следует
размещать
так
,
чтобы
их
можно
было
рассматривать
без
поворота
страницы
.
Если
такое
размещение
невозможно
,
рисунки
следует
располагать
так
,
чтобы
для
просмотра
надо
было
повернуть
страницу
по
часовой
стрелке
.
В
этом
случае
верхним
краем
является
левый
край
страницы
.
Расположение
и
размеры
полей
сохраняются
.
Схемы
алгоритмов
должны
быть
выполнены
в
соответствии
со
стандартом
ЕСПД
.
Толщина
сплошной
линии
при
вычерчивании
схем
алгоритмов
должна
составлять
от
0,6... 1 ,5
мм
.
Надписи
на
схемах
должны
быть
выполнены
чертежным
шрифтом
,
высота
букв
и
цифр
должна
быть
не
менее
3,5
мм
.
Номер
таблицы
размещают
в
правом
верхнем
углу
или
перед
заголовком
таблицы
,
если
он
есть
.
Заголовок
,
кроме
первой
буквы
,
выполняют
строчными
буквами
.
Ссылки
на
таблицы
в
тексте
пояснительной
записки
указывают
в
виде
слова
«
табл
.»
и
номера
таблицы
.
Например
:
Результаты
тестов
приведены
в
табл
. 4.
Номер
формулы
ставится
с
правой
стороны
страницы
в
крутых
скобках
на
уровне
формулы
.
Например
:
z: =sin (x)+In (y);
(12)
Ссылка
на
номер
формулы
дается
в
скобках
.
Например
: «
расчет
значений
проводится
по
формуле
(12)».
Оформление
приложений
.
Каждое
приложение
должно
начинаться
с
новой
страницы
с
указанием
в
правом
углу
слова
«
ПРИЛОЖЕНИЕ
»
прописными
буквами
и
иметь
тематический
заголовок
.
При
наличии
более
одного
приложения
все
они
нумеруются
арабскими
цифрами
:
ПРИЛОЖЕНИЕ
1,
ПРИЛОЖЕНИЕ
2
и
т
.
д
.
Например
:
ПРИЛОЖЕНИЕ
2
Титульный
лист
расчетно
-
пояснительной
записки
Рисунки
и
таблицы
,
помещаемые
в
приложении
,
нумеруют
арабскими
цифрами
в
пределах
каждого
приложения
с
добавлением
буквы
«
П
».
Например
:
Рис
.
П
. 12 - 12-
й
рисунок
приложения
;
Рис
.
Ш
.2 - 2-
й
рисунок
1 -
го
приложения
.
Если
в
приложении
приводится
текст
программы
,
то
каждый
файл
оформляют
как
рисунок
с
наименованием
файла
и
его
назначением
,
например
:
Рис
.
П
2.4.
Файл
menuran.pas-
программа
движения
курсора
основного
меню
.
Оформление
списка
литературы
.
Список
литературы
должен
включать
все
использованные
источники
.
Сведения
о
книгах
(
монографиях
,
учебниках
,
пособиях
,
справочниках
и
т
.
д
.)
должны
содержать
:
фамилию
и
инициалы
автора
,
заглавие
книги
,
место
издания
,
издательство
,
год
издания
.
При
наличии
трех
и
более
авторов
допускается
указывать
фамилию
и
инициалы
только
первого
из
них
со
словами
«
и
др
.».
Издательство
надо
приводить
полностью
в
именительном
падеже
:
допускается
сокращение
названия
только
двух
городов
:
Москва
(
М
.)
и
Санкт
-
Петербург
(
СПб
.).
Сведения
о
статье
из
периодического
издания
должны
включать
:
фамилию
и
инициалы
автора
,
наименование
статьи
,
издания
(
журнала
),
серии
(
если
она
есть
),
год
выпуска
,
том
(
если
есть
),
номер
издания
(
журнала
)
и
номера
страниц
,
на
которых
помещена
статья
.
При
ссылке
на
источник
из
списка
литературы
(
особенно
при
обзоре
аналогов
)
надо
указывать
порядковый
номер
по
списку
литературы
,
заключенный
в
квадратные
скобки
;
например
: [5].
11.6.
Правила
оформления
расчетно
-
пояснительных
записок
при
курсовом
проектировании
При
оформлении
пояснительных
записок
следует
придерживаться
ГОСТ
7.32-91 (
ИСО
5966-
82) «
Отчет
по
научно
-
исследовательской
работе
.
Структура
и
правила
оформления
».
В
соответствии
с
этим
стандартом
текстовый
документ
подобного
типа
должен
включать
:
•
титульный
лист
,
•
реферат
,
•
содержание
,
•
введение
,
•
основную
часть
,
•
заключение
,
•
список
использованных
источников
,
в
том
числе
литературы
,
•
приложения
.
Титульный
лист
оформляют
в
соответствии
с
ГОСТ
19.104—78 «
Единая
система
программной
документации
.
Основные
надписи
» (
рис
. 11.1).
Вторая
страница
-
реферат
или
аннотация
на
разрабатываемый
программный
продукт
.
Реферат
в
сжатом
виде
должен
содержать
сведения
об
объеме
документа
,
количестве
иллюстраций
,
таблиц
приложений
и
т
.
п
.,
а
также
перечень
ключевых
слов
и
основные
положения
документа
.
Например
,
для
отчета
по
научно
-
исследовательской
работе
:
описание
объекта
исследования
,
цели
работы
,
методы
исследования
и
аппаратура
,
полученные
результаты
,
рекомендации
по
внедрению
и
т
.
д
.
В
аннотации
также
в
сжатом
виде
описывают
назначение
и
особенности
разработки
,
но
она
обычно
не
включает
сведений
об
объеме
и
т
.
п
.
Третья
страница
-
содержание
,
включающее
:
введение
,
наименование
всех
разделов
,
подразделов
,
пунктов
,
заключение
,
списки
литературы
и
приложений
с
указанием
номеров
страниц
.
Ни
аннотация
или
реферат
,
ни
самосодержание
в
оглавлении
не
упоминают
.
Затем
следуют
разделы
документа
в
порядке
,
определенном
логикой
изложения
материала
.
Далее
могут
следовать
приложения
,
содержащие
материал
,
не
вошедший
в
документ
по
причине
его
ограниченного
объема
,
но
интересный
для
более
глубокого
понимания
излагаемого
материала
.
В
качестве
примера
рассмотрим
оглавление
пояснительной
записки
к
проекту
по
курсу
«
Технология
программирования
».
Содержание
Введение
..................................................................................................................................................4
1.
Выбор
технологии
,
языка
и
среды
программирования
.....................................................................6
2.
Анализ
и
уточнение
требований
к
программному
продукту
..........................................................7
2.1.
Анализ
процесса
обработки
информации
и
выбор
структур
данных
для
ее
хранения
..............................................................................................................7
2.2.
Выбор
методов
и
разработка
основных
алгоритмов
решения
задачи
...................................9
3.
Разработка
структурной
схемы
программного
продукта
............................................................. 11
4.
Проектирование
интерфейса
пользователя
.................................................................................... 13
4.1.
Построение
графа
диалога
...................................................................................................... 13
4.2.
Разработка
форм
ввода
-
вывода
информации
........................................................................ 14
5.
Проектирование
классов
предметной
области
.............................................................................. 17
5.1.
Построение
диаграммы
классов
............................................................................................. 17
5.2.
Уточнение
структуры
классов
предметной
области
и
разработка
алгоритмов
методов
.......................................................................................... 19
6.
Выбор
стратегии
тестирования
и
разработка
тестов
..................................................................... 21
Заключение
........................................................................................................................................... 24
Список
литературы
.............................................................................................................................. 25
Приложение
1.
Техническое
задание
................................................................................................. 26
Приложение
2.
Руководство
пользователя
........................................................................................ 30
Контрольные
вопросы
1.
Назовите
основные
виды
программной
документации
.
Охарактеризуйте
каждый
из
них
.
В
каких
случаях
их
используют
?
2.
Что
должно
описываться
в
пояснительной
записке
?
Кому
она
предназначена
?
Почему
в
пояснительной
записке
обычно
описывают
не
только
принятые
решения
,
но
и
отвергнутые
варианты
?
3.
На
кого
рассчитано
руководство
пользователя
?
Что
оно
должно
содержать
?
В
каких
ситуациях
вы
читаете
руководство
пользователя
?
Вспомните
прочитанные
вами
руководства
пользователя
.
Что
вам
в
них
не
понравилось
?