Методические указания для студентов специальности 1-40 01 02-03 «Информационные системы и технологии (издательско-полиграфический комплекс)» Минск 2010 - страница 7
.RU

Методические указания для студентов специальности 1-40 01 02-03 «Информационные системы и технологии (издательско-полиграфический комплекс)» Минск 2010 - страница 7


Единица физической величины одного и того же параметра в пределах записки должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например 1,50; 1,75; 2,00 м. Если в пояснительной записке приводят диапазон числовых значений физической величины, выраженных в одной и той же единице измерения, то обозначение единицы физической величины указывается после последнего числового значения диапазона.
Примеры

1. От 1 до 5 мм.

2. От 10 до 100 кг.

3. От плюс 10 до плюс 40 °С.

Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы), кроме единиц физических величин, помещаемых в таблицах, выполненных машинописным способом.
Приводя наибольшие или наименьшие значения величин, следует применять словосочетание «должно быть не более (не менее)». Приводя допустимые значения отклонений от указанных норм, требований, следует применять словосочетание «не должно быть более (менее)». Числовые значения величин в тексте следует указывать со степенью точности, которая необходима для обеспечения требуемых свойств объекта, при этом в ряду величин осуществляется выравнивание числа знаков после запятой.
Порядковые числительные пишут цифрами в сопровождении однобуквенного падежного окончания, если предпоследняя буква числительного гласная, и двухбуквенного окончания, если предпоследняя буква согласная, например «В 3-м разделе показано…», «Сопоставляя результаты 1-го и 2-го экспериментов…».
^ Количественные числительные, обозначаемые цифрами, пишут без падежных окончаний, например «на 10 листах», «по результатам 15 экспериментов». 3.4 Основные правила написания математических формул Уравнения и формулы следует выделять из текста в отдельную строку симметрично тексту пояснительной записки. Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки. Если формула не умещается в одну строку, то она должна быть перенесена после знака равенства (=) или после знаков плюс (+), минус (–), умножения (×), деления (:) или других математических знаков, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак «×».
Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.

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

Перечень начинают со слова «где» (без двоеточия), которое для формул, выделенных в отдельные строки, необходимо записывать с новой строки без абзацного отступа и в этой же строке после слова «где» приводить первый поясняющий символ. Расшифровку символов и числовых коэффициентов можно начинать со слова «здесь». В этом случае после формулы следует ставить точку, а слово «здесь» писать с прописной буквы с новой строки без абзацного отступа.
Если формула содержит выражение для вычисления какой-либо величины и заканчивается ее численным значением, то размерность этой величины следует заключать в круглые скобки. Формулы должны быть вписаны отчетливо с точным размещением знаков, цифр и букв. Каждую букву в формулах и обозначениях необходимо записывать в точном соответствии с алфавитом, которому она принадлежит, и с правилами написания строчных и прописных букв. На протяжении всей пояснительной записки необходимо соблюдать в формулах следующие размеры: 3, 4 мм для строчных и 6, 8 мм для прописных букв и цифр. Все индексы и показатели степени должны быть по размеру в полтора-два раза меньше буквенных обозначений, к которым они относятся. Все формулы, расположенные в отдельных строках, за исключением формул, помещаемых в приложении, должны нумероваться сквозной нумерацией арабскими цифрами в круглых скобках в крайнем правом положении на строке. Одним номером отмечают также группу однотипных формул, размещенных на одной строке. Одну формулу обозначают – (1).
Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед цифрой обозначения приложения, например формула (В.1).

Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например уравнение (3.1). Если в разделе одна формула, то ее также нумеруют, например формула (1.1).
^ Номер однострочной формулы располагают на продолжении строки, занимаемой формулой.
При переносе формулы с одной строки на другую номер располагают на продолжении последней строки.

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

  1. ^ 5 Оформление иллюстраций и приложений

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

Иллюстрации могут быть в компьютерном исполнении, в том числе и цветные. Фотоснимки размером меньше формата А4 должны быть наклеены на стандартные листы белой бумаги.

Чертежи, схемы, диаграммы и т. п., помещаемые в тексте, должны соответствовать требованиям стандартов ЕСКД.

На каждую иллюстрацию должна быть дана ссылка в тексте записки. При ссылках на иллюстрации рекомендуется писать «…в соответствии с рисунком 2» при сквозной нумерации и «…в соответствии с рисунком 1.2» при нумерации в пределах раздела. В ссылках рекомендуется использовать слова «изображены», «показаны», «построены» и т. п.

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

В тексте записки на все приложения должны быть даны ссылки. Степень обязательности приложений при ссылках не указывается. Приложения располагают в порядке ссылок на них в тексте записки.

Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «ПРИЛОЖЕНИЕ» и его обозначения, под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного ­ «рекомендуемое» или «справочное». Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой.

Приложения обозначают (нумеруют) прописными буквами, начиная с буквы А. При обозначении из русского алфавита исключают буквы Е, З, Й, О, Ч, Ъ, Ы, Ь, а из белорусского – буквы Дж, Дз, Е, З, Й, О, Ў, Ч, Ы, Ь. После слова «ПРИЛОЖЕНИЕ» следует буква, обозначающая последовательность его упоминания в тексте.

В случае полного использования букв алфавита последующие приложения обозначаются арабскими цифрами.

Если в пояснительной записке одно приложение, то оно обозначается «ПРИЛОЖЕНИЕ А».

Приложения, как правило, выполняют на листах формата А4. Допускается оформлять приложения на листах формата А3, А43, А44, А2 и А1 по ГОСТ 2.301.

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

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

^ 3.6 Построение таблиц

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

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

Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 1.

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







Примечание – В графах (строках), обозначенных «*» запись слов (словосочетаний) начинают со строчной буквы.

Рисунок 1 – Оформление таблицы


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

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

На все таблицы должны быть даны ссылки в тексте документа; при ссылке нужно писать слово «таблица» с указанием ее номера.

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

Таблицы слева, справа и снизу, как правило, ограничивают линиями.

Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.

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

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

Головка таблицы должна быть отделена линией от остальной части таблицы.

Высота строк таблицы должна быть не менее 8 мм. Таблицу в зависимости от ее размера помещают под текстом, в котором впервые дана на нее ссылка, или на следующей странице, а при необходимости – в приложении к документу.

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

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

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

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

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

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

Графу «Номер по порядку» в таблицу включать не допускается.

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

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

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

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

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321, или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например: D ­ диаметр, Н ­ высота, L ­ длина.

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

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

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

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

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

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

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

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

Предельные отклонения, относящиеся ко всем числовым значениям величин, помещенным в одной графе, указывают в головке таблицы под наименованием или обозначением показателя, например «±0,5».

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

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

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

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

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

При отсутствии отдельных данных в таблице следует ставить прочерк (тире).

При указании в таблицах последовательных интервалов чисел, охватывающих все числа ряда, перед числами пишут «от … до … включ.», «св. … до … включ.».

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

Интервалы чисел в тексте записывают со словами «от» и «до» (имея в виду «от … до … включительно»), если после чисел указана единица физической величины или числа представляют безразмерные коэффициенты, либо через дефис, если числа представляют порядковые номера.

Примеры

1 … диаметр окружности должен быть от 2,5 до 3,5 мм.

2 … рисунках 1–5.

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

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

Числовое значение показателя проставляют на уровне последней строки наименования показателя.

Значение показателя, приведенное в виде текста, записывают на уровне первой строки наименования показателя.

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

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

Пример

Предельные отклонения размеров профилей всех размеров, %:

по высоте…………………………………….2,5

по ширине полки……………………………1,5

по толщине стенки……………………….…0,3

по толщине полки…………………….….…0,3

  1. 7 Сноски

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

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

Знак сноски ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение, и перед текстом пояснения.

Знак сноски выполняют арабскими цифрами со скобкой и помещают на уровне верхнего обреза шрифта.

Пример – «… печатающее устройство2)…».

Нумерация сносок отдельная для каждой страницы.

Допускается вместо цифр выполнять сноски звездочками: *. Применять более четырех звездочек не рекомендуется.

  1. ^ 8 Примечания и примеры

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

Примечания не должны содержать требований. Примечания к таблицам и рисункам могут включать требования.

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

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

Примеры размещают, нумеруют и оформляют так же, как и примечания.

  1. ^ 9 Оформление библиографического указателя
    «Список использованных источников»

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

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

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

Без ссылок в тексте пояснительной записки разрешается использовать сведения, полученные на лекциях, семинарских, практических и лабораторных занятиях. Однако использованные учебные, учебно-методические материалы и пособия должны быть приведены и расположены в конце указателя.

Библиографические записи в указателе «Список использованных источников» должны быть выполнены в точном соответствии с требованиями стандарта ГОСТ 7.1-2003.

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

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

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

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

При необходимости сокращения количества авторов в сведениях об ответственности приводят фамилию и инициалы первого автора с добавлением сокращения «и другие», т. е. [и др.], или его эквивалента на латинском языке [et al.].

Обозначение индивидуального номера книги (ISBN) в библиографическом описании является обязательным.

Примеры библиографических записей приведены в приложении Д.



^ 4 ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

4.1 Общие положения

Алгоритм – точное предписание исполнителю совершить определенную последовательность действий для достижения поставленной цели за конечное число шагов.

Программа – данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определенного алгоритма.

Программы подразделяют на следующие виды:

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

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

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

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

Различают следующие типы программных модулей:

К программным относят документы, содержащие в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации и сопровождения программ или программных средств.

В пояснительной записке к дипломному проекту (работе) рекомендуется приводить следующие виды программных документов:

Примечание – Описание применения и руководства системного программиста, программиста и оператора являются эксплуатационными программными документами.

^ 4.2 Описание применения

Текст документа включает следующие части:

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

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

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

В части «Описание задачи» должны быть указаны определения задачи и методы ее решения.

В части «Входные и выходные данные» нужно указать сведения о входных и выходных данных.

^ 4.3 Описание программы

Описание программы содержит следующие части:

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

В части «Общие сведения» указывают:

В части «Описание логической структуры» указываются:

Описание логической структуры программы выполняют на основании исходного текста программы.

В части «Используемые технические средства» указывают типы ЭВМ и устройств, используемых при работе программы.

В части «Вызов и загрузка» описываются:

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

В части «Входные данные» указывают:

В части «Выходные данные» описывают:

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

В приложении к описанию программы можно приводить различные материалы, которые нецелесообразно включать в документ «Описание программы».

^ 4.4 Руководство системного программиста

Руководство системного программиста должно содержать следующие части:

В зависимости от особенностей документа допускается объединять отдельные части или вводить новые.

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

В части «Структура программы» приводятся сведения о структуре программы, ее составных частях, связях между составными частями и связях с другими программами.

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

При необходимости приводят поясняющие примеры.

В части «Проверка программы» описываются способы проверки, позволяющие дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).

В части «Дополнительные возможности» должно быть приведено описание дополнительных функциональных возможностей программы и способов их выбора.

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

В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).

^ 4.5 Руководство программиста

Руководство программиста должно содержать следующие части:

В зависимости от особенностей документа допускается объединять отдельные части или вводить новые.

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

В части «Характеристики программы» приводится описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.).

В части «Обращение к программе» приводится описание процедуры вызова программы (способы передачи управления и параметров данных и др.).

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

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

В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).

^ 4.6 Руководство оператора

Руководство оператора должно содержать следующие части:

В зависимости от особенностей документа допускается объединять отдельные части или вводить новые.

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

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

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

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

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

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

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

^ 4.7 Текст программы

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

Допускается вводить наименования и для совокупности частей.

Каждая из этих частей реализуется одним из типов символической записи, например:

В начале каждой части документа рекомендуется указывать:

В первой части дополнительно рекомендуется приводить:

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

При реализации модулей, функций, процедур и других компонентов программы необходимо, чтобы:

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

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

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

^ 5 ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ
ГРАФИЧЕСКОЙ ЧАСТИ

5.1 Общие положения

Графический материал дипломного проекта (работы) представляется в виде чертежей, схем, графиков и т. д. формата А1. Содержание чертежей определяется видом дипломного проекта (конструкторский, технологический, исследовательский).

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

– схема программного обеспечения.

Графический материал дипломного проекта должен быть оформлен в соответствии с ЕСКД, а также требованиями действующих ГОСТов. Графический материал (схемы, перечень элементов) может выноситься в приложения. Не допускается пояснять работу алгоритма (алгоритмов) в тексте записки, ссылаясь на графический материал приложений. Должны быть приведены все необходимые поясняющие рисунки в самом тексте пояснительной записки.

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

XXХХ X XXX XXX XX, ,

1 2 3 4 5

где 1 – РТДП – для дипломных проектов; РТКП – для курсовых проектов;

2 – индекс иерархии документа (от 0 до 8);

3 – условное обозначение изделия по классификатору;

4 – порядковый номер документа (например 003 – третий документ);

5 – индекс чертежа: СС – схема структуры системы; СГ – сетевые графики; СА– схема алгоритма, СП – схема программного обеспечения и т. д.

Наименование и код схем определяют их видом и типом.

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

    1. ^ Правила выполнения схем алгоритмов и программ

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

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

Приведем определения основных понятий.

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

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

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

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

Символы данных предшествуют и следуют за символами процесса. Схема данных начинается и заканчивается символами данных (за исключением специальных символов – «соединитель» и «терминатор»).

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

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

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

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

Описание символов схем представлено в приложении Е.

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

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

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

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


а
А := В

В := С

В := С

А := В
б

Рисунок 2 – Чтение вида а


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


ххх...х

ууу...у

Рисунок 3 – Идентификаторы над символами

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


ххх...х

ууу...у


Рисунок 4 – Размещение описания символа


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

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

Потоки данных или потоки управления в схемах показываются линиями. Направление потока слева направо и сверху вниз считается стандартным.

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

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

Две или более входящих линий могут объединяться в одну исходящую линию. Если две или более линий объединяются в одну линию, то место объединения должно быть смещено.

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

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

Несколько выходов из символа следует показывать:

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

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

Когда несколько символов представляют упорядоченное множество, это упорядочение должно располагаться от переднего (первого) к заднему (последнему).

Примеры применения символов и выполнения схем представлены в приложении Е.




^ ПРИЛОЖЕНИЕ А

(справочное)

Перечень нормативных ссылок

ГОСТ 2.004-88. Единая система конструкторской документации. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ

ГОСТ 2.105-95. Единая система конструкторской документации. Общие требования к текстовым документам

ГОСТ 2.701-84. Единая система конструкторской документации. Схемы. Виды и типы. Общие требования к выполнению.

ГОСТ 2.702-75. Единая система конструкторской документации. Правила выполнения электрических схем

ГОСТ 2.708-81. Единая система конструкторской документации. Правила выполнения электрических схем цифровой вычислительной техники.

ГОСТ 2.721-74 – ГОСТ 2.770-68. Единая система конструкторской документации. Обозначения условные графические в схемах

ГОСТ 7.1-2003. Система стандартов по информации, библиотечному и издательскому делу. Библиографическое описание документа. Общие требования и правила оформления

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

ГОСТ 8.417-2002. Государственная система обеспечения единства измерений. Единицы физических величин

ГОСТ 19.001-77. Единая система программной документации. Общие положения

ГОСТ 19.101-77. Единая система программной документации. Виды программ и программных документов

ГОСТ 19.401-2000. Единая система программной документации. Текст программы. Требования к содержанию, оформлению и контролю качества

ГОСТ 19.402-2000. Единая система программной документации. Описание программы. Требования к содержанию, оформлению и контролю качества

ГОСТ 19.503-79. Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению

ГОСТ 19.504-79. Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению

ГОСТ 19.505-79. Единая система программной документации. Руководство оператора. Требования к содержанию и оформлению

ГОСТ 19.701-90. Единая система программной документации. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения

ГОСТ 19781-90. Программное обеспечение систем обработки информации. Термины и определения

СТБ 1.5-96. Государственная система стандартизации Республики Беларусь. Требования к построению, изложению, оформлению и содержанию стандартов




^ ПРИЛОЖЕНИЕ Б

(обязательное)

Пример оформления титульного листа пояснительной записки


МИНИСТЕРСТВО ОБРАЗОВАНИЯ РЕСПУБЛИКИ БЕЛАРУСЬ


metodicheskie-ukazaniya-dlya-vipolneniya-kursovoj-raboti-po-discipline-makroekonomika-dlya-studentov-napravleniya-podgotovki.html
metodicheskie-ukazaniya-dlya-vipolneniya-kursovoj-raboti-po-discipline-strahovanie-na-transporte.html
metodicheskie-ukazaniya-dlya-vipolneniya-kursovoj-raboti-po-statistiko-ekonomicheskomu-analizu-nalogooblozheniya-na-predpriyatii-v-rajone-regione-i-rossijskoj-federacii-dlya-studentov-ochnogo-i-zaochnogo-otdelenij-specialnostej.html
metodicheskie-ukazaniya-dlya-vipolneniya-kursovoj-rabotipo-specialnosti-050807-lesohozyajstvennoe-delo-pavlodar.html
metodicheskie-ukazaniya-dlya-vipolneniya-laboratornoj-raboti-po-discipline-termodinamika-i-rabochie-processi-dvigatelej-gos-2000-dlya-studentov-vseh-form-obucheniya-specialnosti.html
metodicheskie-ukazaniya-dlya-vipolneniya-referatov.html
  • occupation.bystrickaya.ru/neznakomaya-italiya-markeumbriya.html
  • klass.bystrickaya.ru/babroteka-elektronnaya-biblioteka-babrakisunko-g-vsekretnaya-zona-ispoved-generalnogo-konstruktora-stranica-16.html
  • obrazovanie.bystrickaya.ru/preimushestva-franshizi-bohemia-klassicheskaya-posuda-uchebno-metodicheskij-kompleks-specialnosti-080301-kommerciya.html
  • knowledge.bystrickaya.ru/nachalo-hh-veka-ioso-rao.html
  • letter.bystrickaya.ru/more-i-noch-stranica-14.html
  • klass.bystrickaya.ru/av-selishev-direktor-yuridicheskoj-firmi-yuna-voprosi-arendi-gosudarstvennogo-municipalnogo-imushestva.html
  • essay.bystrickaya.ru/ekonomiki-i-prava.html
  • knigi.bystrickaya.ru/skolkovo-regionalnie-programmi-13-moskva-tarifi-13-moskva-udeshevleniya-elektroenergii-dlya-naseleniya-ne-budet.html
  • gramota.bystrickaya.ru/vvedenie-zakonomernosti-istorichnosti-i-ih-primenenie-v-koncepcii-sovremennogo-estestvoznaniya.html
  • literatura.bystrickaya.ru/shkola-kaysen-sistema-razvitiya-dushi-i-tela-stranica-5.html
  • esse.bystrickaya.ru/rabochaya-programma-uchebnoj-disciplini-struktura-i-osnovi-deyatelnosti-predpriyatij-razlichnoj-napravlennosti.html
  • kolledzh.bystrickaya.ru/5-ugolovno-pravovie-normi-v-zakonah-hammurapi-uchebno-metodicheskij-kompleks-po-discipline-istoriya-gosudarstva.html
  • books.bystrickaya.ru/direktora-mou-toguchinskogo-rajona.html
  • znanie.bystrickaya.ru/administrativnoe-delenie-rajona-shema-territorialnogo-planirovaniya-majkopskogo-rajona-respubliki-adigeya.html
  • universitet.bystrickaya.ru/tema-uroka-srok.html
  • znaniya.bystrickaya.ru/razrabotchik-programma-professionalnoj-podgotovki-professionalnoj-podgotovki-perepodgotovki-povisheniya-kvalifikacii.html
  • portfolio.bystrickaya.ru/osnovnaya-obrazovatelnaya-programma-nachalnogo-obshego-obrazovaniya-soderzhanie-stranica-11.html
  • grade.bystrickaya.ru/nachalnik-vspomogatelnogo-otdela-kadrov-specotdela-idr-sbornik-rukovodyashih-dokumentov-po-zapovednomu-delu.html
  • report.bystrickaya.ru/informacionno-tehnologicheskie-resursi-rossijskih-regionov-ocenka-i-sravnitelnij-analiz.html
  • pisat.bystrickaya.ru/tema-17-novie-religioznie-dvizheniya-religiya-i-ekonomika-v-sovremennom-mire.html
  • bukva.bystrickaya.ru/shpargalka-po-marketingu-3.html
  • shkola.bystrickaya.ru/ob-utverzhdenii-regionalnoj-programmi-razvitie-konkurencii-v-arhangelskoj-oblasti-v-2010-2012-godah-stranica-4.html
  • university.bystrickaya.ru/et-jtais-fier-de-lui-apprendre-que-je-volais-alors-il-scria-francuzskij-yazik-s-malenkim-princem.html
  • apprentice.bystrickaya.ru/zapadno-frankskoe-korolevstvo.html
  • paragraf.bystrickaya.ru/vsya-eta-knigaeres-ot-nachala-i-do-konca-no-eto-daleko-ne-polnoe-sobranie-eresej-kotorie-mogut-prijti-na-um-lyudyam-esli-im-udarili-v-golovu-misli-o-dobre-i-zle-stranica-6.html
  • literature.bystrickaya.ru/demograficheskaya-situaciya.html
  • ekzamen.bystrickaya.ru/reshenie-5-byuro-prezidiuma-moo-rakc.html
  • znaniya.bystrickaya.ru/rabochaya-programma-disciplini-marketing-v-socialno-kulturnom-servise-i-turizme-po-specialnosti-230500-socialno-kulturnij-servis-i-turizm.html
  • crib.bystrickaya.ru/ii-smerdyakov-s-gitaroj-fedor-mihajlovich-dostoevskij.html
  • portfolio.bystrickaya.ru/pervij-period-m-v-bahtin-istoriya-hristianskoj-cerkvi-do-1054-goda-moskva-izdatelstvo-moskovskogo-instituta.html
  • knigi.bystrickaya.ru/snova-vmeste.html
  • klass.bystrickaya.ru/4investicii-v-otrasl-i-zatrati-na-niokr-7-ocenka-konkurentosposobnosti-rossijskogo-tyazhelogo-mashinostroeniya-25.html
  • learn.bystrickaya.ru/glava-25-uchebnij-material-ironiya-sudbi-eldara-ryazanova-ili-obraz-intelligenta-bez-refleksii.html
  • laboratory.bystrickaya.ru/zhemchuzhini-rossii-berezovo.html
  • predmet.bystrickaya.ru/rol-bankov-vtorogo-urovnya-v-razvitii-i-povishenii-konkurentosposobnosti-regiona.html
  • © bystrickaya.ru
    Мобильный рефератник - для мобильных людей.