Структура программного продукта
Поможем в ✍️ написании учебной работы
Поможем с курсовой, контрольной, дипломной, рефератом, отчетом по практике, научно-исследовательской и любой другой работой

Не допускается использование подчеркивания в заголовках. Не допускается также использование двух и более типов выделения в заголовках (например, курсив и жирный шрифт, курсив и другой цвет, отличный от основного текста). Не допускается также перенос слов в заголовках глав и параграфов.

Размер символов в математических выражениях не должен превышать размер символов основного текста.

Главы, параграфы, пункты и подпункты (кроме введения, заключения, списка литературы и приложений) нумеруют арабскими цифрами. Предельная нумерация для подразделов – трехзначная. Внутри пунктов или подпунктов могут быть приведены перечисления, которые отделяют друг от друга точкой с запятой. Начало каждой позиции перечисление – абзац 1,25 см. Перед каждой позицией перечисления следует ставить только дефис, например

– модифицированный метод случайного баланса;

– метод наименьших квадратов с предварительной ортогонализацией факторов;

– метод точечных распределений.

Пример перечислений с вложениями:

а) выполнение – состояние процесса, во время которого процесс обладает всеми необходимыми ресурсами и непосредственно выполняется процессором;

б) ожидание – процесс заблокирован:

1) он не может выполняться по своим внутренним причинам;

2) он ждет осуществления некоторого события, например, завершения операции ввода-вывода;

Слово "глава" не пишется. Заголовки должны четко и кратко отражать содержание раздела. Нельзя использовать аббревиатуры (сокращения) без первого полного упоминания в тексте. Числовые значения величин с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения от единицы до девяти – словами, например, 3 км, но – три программы. Если приводится ряд или диапазон числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например; 1,50; 1,75; 2,00 В; от 10 до 100 Ом. Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы).

Количество уровней заголовков в работе определяется тематикой работы и научным руководителем.

Оформление графического материала

Рисунки. Иллюстрации (чертежи, графики, схемы, диаграммы, фотоснимки, рисунки) следует располагать в работе непосредственно после текста, в котором они упоминаются впервые, или на следующей странице, если в указанном месте они не помещаются. На все иллюстрации должны быть даны ссылки в работе. Иллюстрации должны иметь названия, которые помещают под иллюстрацией. Иллюстрации следует нумеровать арабскими цифрами порядковой нумерацией в пределах глав, например, «Рисунок 2.1 – Блок-схема» (первый рисунок второго раздела). Если в работе только одна иллюстрация, ее нумеровать не следует и слово "Рисунок" под ней не пишут. Количество рисунков в пояснительной записке должно быть достаточным для того, чтобы ее текст можно было читать с минимальным обращением к документам графической части проекта.

При ссылках на иллюстрации следует писать «... на рисунке 1.2». Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например: «Рисунок А.3 – Вид окна ввода». Если в приложениях большое количество рисунков, то наименования рисунков можно не употреблять, а только его нумеровать. В случае, когда рисунок занимает страницу целиком и ориентация рисунка альбомная, подпись с названием рисунка располагается под рисунком, вертикально, с внешней стороны страницы.

Для схем алгоритмов и программ, располагаемых на нескольких листах пояснительной записки, на первом листе указывается «Рисунок 1.2 – Функциональная схема», на последующих листах – «Продолжение рисунка 1.2».

Если наименование рисунка занимает более одной строки, то межстрочный интервал должен быть одинарным. Точка по окончании наименования рисунка не ставится.

Между рисунком и основным текстом работы (до рисунка и после наименования рисунка) следует оставить пустую строку одинарного интервала 12 pt.

Диаграммы. При изображении диаграмм оси координат шкал следует выполнять сплошной толстой линией, а координатную сетку сплошной тонкой линией. Допускается линии сетки выполнять в местах, соответствующих кратным графическим интервалам, или делать засечки вместо линий. Функциональные зависимости предпочтительно выполнять сплошной линией.

При изображении двух и более функциональных зависимостей на одной диаграмме допускается использовать линии различных типов (сплошную, штриховую и т. д.). При этом для каждой функциональной зависимости может быть использована своя шкала.

Единицы измерения на диаграммах наносятся вместе с обозначением переменной величины, после запятой.

Пересечения надписей и линий на диаграмме не допускаются. При недостатке места следует прерывать линию. Подпись диаграммы выполняется по правилу подписей рисунков, например, «Рисунок 2.5 – Диаграмма классов».

В случае, если к диаграмме необходимы пояснения (легенда диаграммы), они указываются либо на самой диаграмме – при ее построении в редакторе, либо в подписи к рисунку, после его названия.

Таблицы. Цифровой материал рекомендуется помещать в работе в виде таблиц. Таблицу следует располагать в работе непосредственно после текста, в котором она упоминается впервые, или на следующей странице, а при необходимости - в приложении. Таблицы располагаются по центру документа. До названия таблицы и после самой таблицы должна быть пустая строка интервалом 1,0 размером шрифта 12 pt. Между названием таблицы и самой таблицей – интервал 6 pt. В шапке таблицы переносы слов запрещены. По возможности в ячейках таблицы переносы не используются.

На все таблицы должны быть ссылки в тексте. При ссылке следует писать слово «таблица» с указанием номера, например, «таблица 2.1». Таблицы следует нумеровать арабскими цифрами порядковой нумерацией в пределах глав. Если в работе одна таблица, ее не нумеруют и слово «Таблица» не пишут.

Слово "Таблица" и наименование таблицы начинаются с прописной буквы, точка в конце заголовка не ставится. Заголовки граф таблицы должны начинаться с прописных букв, подзаголовки – со строчных, если последние подчиняются заголовку. Заголовки граф таблиц должны быть выровнены по центру относительно ячейки.

Допускается располагать таблицу в альбомном формате.

Каждая таблица должна иметь номер и наименование, которые располагаются в центре страницы над таблицей, например,

Таблица 3.4 – Вероятность появления угроз

Вероятность Средняя частота появления
0 -
1 реже, чем 1 раз в год
2 около 1 раза в год
3 около 1 раза в месяц
4 около 1 раза в неделю
5 практически ежедневно

 

Таблицы слева, справа и снизу, как правило, ограничивают линиями. Если в конце страницы таблица прерывается, то линию, ограничивающую таблицу снизу, не проводят. Высота строк таблицы должна быть не менее 12 pt . В одной графе должно быть соблюдено, как правило, одинаковое количество десятичных знаков для всех значений величин. При отсутствии отдельных данных в таблице следует ставить прочерк (тире).

Шрифт в таблицах используется Times New Roman, 12 pt, одинарный интервал. Заголовки граф указываются в единственном числе. Таблицу следует размещать так, чтобы читать ее без поворота работы, если такое размещение невозможно, таблицу располагают так, чтобы ее можно было читать, поворачивая работу по часовой стрелке. При переносе таблицы на другую страницу название столбцов таблицы следует повторить, и над ней по центру размещают слова "Продолжение таблицы" с указанием ее номера. Если шапка таблицы велика, допускается ее не повторять: в этом случае следует пронумеровать графы и повторить их нумерацию на следующей странице. Наименование таблицы не повторяют. Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.

Заменять кавычками повторяющиеся в таблице цифры, математические знаки, знаки процента, обозначения марок материала, обозначения нормативных документов не допускается.

 Формулы и уравнения. В формулах в качестве символов следует применять обозначения, установленные соответствующими стандартами. Пояснения символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее, должны быть приведены непосредственно под формулой. Пояснения каждого символа следует давать с новой строки в той последовательности, в которой они приведены в формуле. Первая строка пояснения должна начинаться со слова «где», без двоеточия после него, без абзацного отступа. Набор формул необходимо осуществлять в соответствующем редакторе.

Формулы и математические уравнения рекомендуется набирать в редакторе формул Microsoft Equation 3.0 по требованиям ГОСТ 7.32-2001.

Требования к размерам: обычный символ 14 pt; крупный индекс 10 pt; мелкий индекс 8 pt; крупный символ 20 pt; мелкий символ 14 pt.

Уравнения и формулы следует выделять из текста в отдельную строку. Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки одинарного интервала, размером шрифта 12 pt без отступов. Если уравнение не умещается в одну строку, оно должно быть перенесено после знака равенства (=) или после знака (+), или после других математических знаков с их обязательным повторением в новой строке.

Например,

 

                                        ,                                (3.1)

 

Формулы и уравнения в работе следует нумеровать порядковой нумерацией в пределах главы в круглых скобках в крайне правом положении напротив формулы, например,

 

                    ,                 (3.2)

 

где   для всех ;

n – объем выборки.   

Если в работе только одна формула или уравнение, то их не нумеруют.

Если в работе используются русские буквы для обозначения переменных, к ним применяются те же правила оформления.

Ссылки. При ссылке на учебник или пособие после напоминания о нем в тексте работы проставляют в квадратных скобках номер, под которым оно значится в библиографическом списке. В необходимых случаях (обычно при использовании цифровых данных или цитаты) указываются и страницы, на которых помещается используемый источник, например, [9, с. 4-5]. Ссылки на таблицы, рисунки, приложения берутся в круглые скобки. При ссылках следует писать: "в соответствии с данными в таблице 5.1" или (таблица 5.1), "по данным рисунка 3.1" или (рисунок 3.1), "в соответствии с приложением А" или (приложение А).

3.3 Оформление листинга программ

    При оформлении листинга программ  используют шрифт, каждый символ которого при наборе занимает одинаковое место, без курсива.

При оформлении листинга следует использовать шрифт – Courier New; размер шрифта – 12 pt; междустрочный интервал – одинарный; интервалы до и после абзаца – 0 pt; выравнивание – по левому краю; отступы слева и справа – 0 см.

Листинг необходимо нумеровать. При этом требуется под листингом привести номер и название кода по аналогии с нумерацией рисунков (отдельная нумерация внутри главы).

Кроме этого для явного отделения текста листинга от основного текста документа листинг следует помещать в рамку. До рамки и после наименования листинга – пустая строка – 12 pt; междустрочный интервал – одинарный; интервалы до и после абзаца – 0 pt. Пример оформления листинга:

 

Dim FileFree As Integer Dim FileSize As Long FileFree = FreeFile Open “C:\win\general.txt For Input As FileFree FileSize = Lof(FileFree) Close FileFree

Листинг 2.5 – Фрагмент кода

 

Допускается приводить листинги только оригинальных кодов, алгоритмов или решений задач. Стандартные описания, которые присутствуют в большинстве приложений, приводить не имеет смысла.

Листинг, занимающий более половины страницы, следует помещать в приложение без рамки, с его названием в виде заголовка приложения.

Оформление списка литературы

Список литературы должен содержать перечень источников, использованных при выполнении работы.

В список литературы включают все источники в алфавитном порядке авторов. Сначала оформляются монографии, учебники, затем справочники, затем периодические издания (журналы), затем патентные документы, ГОСТы, СНиПы и др., в заключении Интернет-ссылки. Выполнение списка и ссылки на него в тексте – по ГОСТ Р 7.0.11-2011.

Сведения о книгах (монографии, учебники, справочники и т. д.) должны включать: фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания, количество страниц в книге. Допускается сокращение названий городов - М. (Москва), Л. (Ленинград), К. (Киев), Мн. (Минск), СПб. (Санкт-Петербург). Например,

1. Шляндин, В.М. Цифровые измерительные устройства: учебное пособие/ В.М. Шляндин. – М.: Высшая школа, 2005. – 335 с.

Сведения о статье из периодического издания должны включать фамилию и инициалы автора, заглавие статьи, наименование серии (если есть), год выпуска, том (при необходимости), номер издания (журнала), страницы, на которых помещается статья. Например,

1. Пестов, Е.Н. Прецизионный квантовый преобразователь тока / Е.Н. Пестов, П.В. Мокренко // Приборы и системы управления. – 2012. – № 9. – С. 25-28.

Сведения о патентных документах должны включать: характер документа, его номер, страну, выдавшую документ, название, инициалы и фамилию автора, страну, из которой данный автор, когда и где опубликован документ. Например,

3. А. с. 436350 СССР. Двоичный сумматор / К.Н. Корнеев (СССР). – Заявл. 12.01.82; Опубл. 30.03.84, Бюл. №26.

Пример оформления статей из иностранного журнала:

5. Ganagisowa, Т. Active gurutor / Т. Ganagisowa, I. Kawashima// Electronic letters. – 1988. – Vol.3, № 3. – Р. 5-8.

Сведения о стандартах и технических условиях выполняются следующим образом:

4. ГОСТ 7.32–2001 Отчет о научно-исследовательской работе. Структура и правила оформления. – М.: Изд-во стандартов, 2001. – 18 с.

Оформление электронных ресурсов на CD:

7. Шляндин, В.М. Цифровые измерительные устройства [Электронный ресурс] / В.М. Шляндин.  – М.: Большая Рос. энцикл., 2012. – 1 электронн. опт. диск (CD-ROM)

Оформление электронных ресурсов сети Интернет:

12. Шляндин, В.М. Цифровые измерительные устройства [Электронный ресурс] / В.М. Шляндин // Приборостроение. – 2012. – №4. – Режим доступа:

http://www.un.org/ruusian/documen/basicdoc/01.pdf

Оформление приложений

Приложения следует оформлять как продолжение работы на ее последующих страницах, после списка литературы. Каждое приложение должно начинаться с новой страницы и иметь заголовок с указанием вверху справа страницы – слово "ПРИЛОЖЕНИЕ" и его обозначения. Если приложений более одного, то они обозначаются прописными буквами русского алфавита, начиная с буквы А, исключая буквы Ё, 3, И, И, О, Ч, Щ, Ь, Ы, Ъ, после буквы Я приложения обозначаются арабскими цифрами. Листы работы, имеющие формат более А4 помещаются в качестве приложений и складываются по формату листов работы. Если приложений много, они оформляются отдельной книгой, на титульном листе которой должно быть написано прописными буквами слово "ПРИЛОЖЕНИЯ".

Оформление схем алгоритмов

При выполнении схем алгоритмов, программ, данных и систем следует руководствоваться ГОСТ 19.701-90. В соответствии с этим стандартом предусматриваются следующие виды схем: схемы данных (1); схемы программ (2); схемы работы систем (3); схемы взаимодействия программ (4); схемы ресурсов системы (5) в соответствии с таблицей 3.2.

По возможности все символы должны быть одного размера. Внутри символов или рядом с ними в форме комментария помещают текст, служащий для уточнения выполняемых функций. Следует избегать пересечения линий потока, связывающих символы. Указанные линии связи должны быть направлены к центру символа и ориентированы параллельно сторонам листа. Стрелки между элементами должны указывать направление потока.

Оформление структурных схем. На структурной схеме изображают в виде прямоугольников произвольных размеров или условных графических обозначений все основные функциональные части схемы и основные взаимосвязи между ними. На схеме указывают наименования функциональных частей схемы, которые, как правило, вписывают внутрь элементов.

 

Таблица 3.2 – Символы на схемах программных документах по ГОСТ 19.701-90

Символы

Наименования

Символ

применяется в схемах

1 2 3 4 5

А. Основные

Данные + - + + +
Хранимые данные, пригодные для обработки + + + + +
Процесс + + + + +
Поток данных + + + + +

Б. Специфические

Оперативное запоминающее устройство + - + + +
Оперативное запоминающее устройство с последовательным доступом + - + + +
Запоминающее устройство с прямым доступом + - + + +
Ручной ввод + - + + +
Карта + - + + +
Бумажная лента + - + + +
Дисплей + - + + +
Предопределенный процесс - + + + -
Ручная операция + - + + -
Подготовка + + + + -
Решение - + + - -
Параллельное действие - + + + -
Граница цикла - + + - -

Продолжение таблицы 3.2

Символы

Наименования

Символ

применяется в схемах

1 2 3 4 5
Передача управления - - - + -
Канал связи + - + + +
Связь между двумя и более символами + + + + +

В. Специальные

Соединитель + + + + +
Терминатор + + + - -
Комментарий + + + + +
Пропуск + + + + +

 

Допускается помещать на схеме поясняющие надписи, диаграммы или таблицы, определяющие последовательность процессов во времени, а также указывать параметры в характерных точках (значения токов, напряжений, формы импульсов, математические зависимости и т. п.).

На рисунке 3.1 приведен пример оформления структурной схемы системы, а на рисунке 3.2 приведен пример оформления схемы меню системы.

 

Рисунок 3.1 – Структурная схема системы

Рисунок 3.2 – Схема меню системы

 

Рисунок 3.3 – Пример оформления схемы программы согласно ГОСТ

Функциональная схема – документ, разъясняющий процессы, протекающие в отдельных функциональных цепях изделия (установки) или изделия (установки) в целом. Это укрупненная блок-схема, которая показывает протекающие процессы и их взаимосвязь, то есть схема программы.

 

Рисунок 3.4 – Пример оформления функциональной схемы

 

Рисунок 3.5 – Пример оформления схемы взаимодействия программ

согласно ГОСТ

Рисунок 3.6 – Пример оформления схемы ресурсов системы согласно ГОСТ



Дата: 2018-12-28, просмотров: 278.