Специальность 220200 АСОИУ и некоторые магистерские программы направления 552800 Информатика и вычислительная техника в рамках государственных нормативных документов подпадает под комплекс стандартов и руководящих документов на автоматизированные системы «Информационная технология». В этом комплексе имеется пять стандартов, три руководящих документа, и один документ «Рекомендации». Они были разработаны в 1988-90 гг. и утверждены.
В комплекс стандартов и руководящих документов на автоматизированные системы входят следующие.
ГОСТ 34.201–89. Виды, комплектность и обозначения документов при создании автоматизированных систем. Дата введения 01.01.90, срок проверки – 1999 г., периодичность проверки – 10 лет.
ГОСТ 34.602–89. Техническое задание на создание автоматизированной системы. Дата введения – 01.01.90.
РД 50–682–89. Методические указания. Общие положения. Срок действия – с 01.01.90 до 01.01.93.
РД 50–680–88. Методические указания. Основные положения. Дата введения –01.01.90.
ГОСТ 34.601–90. Стадии создания. Дата введения – 01.01.92.
ГОСТ 34.401–90. Средства технические периферийные автоматизированных систем дорожного движения. Срок действия 01.01.92 до 01.01.97. Срок проверки –1995 г., периодичность проверки – 5 лет.
РД 50–34.698–90. Требования к содержанию документов. Дата введения – 01.01.92.
ГОСТ 34.003–90. Термины и определения. Дата введения – 01.01.92.
Р 50–34.119–90. Архитектура локальных вычислительных сетей в системах промышленной автоматизации. Общие положения. Дата введения – 01.01.92.
Стандарты устанавливают термины и определения в области автоматизированных систем (АС) и распространяются на АС, содержанием которых является переработка информации.
Термины, устанавливаемые стандартами, обязательны для применения во всех видах документации и литературы по АС, в области стандартизации и областях, связанных с нею, а также рекомендуются для применения в научно-технической, справочной и учебной литературе.
Для обучения по специальности 230102 (220200) среди перечисленных документов в первую очередь необходимо знать методические указания «Информационная технология», в своем составе имеющие руководящие документы на АС и называющиеся «Автоматизированные системы. Требования к содержанию документов» (РД 50–34.698–90). Этот документ введен в действие с 01.01.92.
Общие положения. Комплекс РД устанавливает требования к содержанию документов, разрабатываемых при создании АС. Эти требования также поддерживаются Единой системой программной документации (ЕСПД), Единой системой конструкторской документации (ЕСКД), Системой проектной документации для строительства (СПДС).
Содержание документов является общим для всех видов АС и при необходимости может дополняться разработчиком в зависимости от особенностей АС. В документы могут включаться дополнительные разделы, объединяться и исключаться разделы.
Содержание каждого документа, разрабатываемого при проектировании АС, определяется разработчиком в зависимости от объекта проектирования.
Содержание документов, разрабатываемых на предпроектных стадиях, определяют разработчики в зависимости от объема информации. Основные стадии развития следующие.
1-я стадия «Формирование требований к АС». Здесь разрабатывается отчет с разделами:
– характеристика объекта и результатов его функционирования;
– описание существующей информационной системы;
– описание недостатков существующей информационной системы;
– обоснование необходимости совершенствования информационной системы;
– цели, критерии и ограничения создания АС;
– функции и задачи создаваемой АС;
– ожидаемые технико-экономические результаты создания АС;
– выводы и предложения.
2-я стадия «Разработка концепции АС». Здесь разрабатывается отчет с разделами:
– результаты изучения объекта автоматизации;
– преимущества и недостатки разработанных альтернативных вариантов концепции создания АС;
– сопоставительный анализ требований пользователя к АС и варианта концепции на предмет удовлетворения требованиям пользователя;
– обоснование выбора оптимального варианта концепции и описание предлагаемой АС;
– ожидаемые результаты и эффективность реализации выбранного варианта концепции АС;
– ориентировочный план реализации выбранного варианта концепции АС;
– необходимые затраты ресурсов на разработку, ввод в действие и обеспечение функционирования;
– требования, гарантирующие качество АС;
– условия приемки системы.
С учётом требований перечисленных документов и на основе ГОСТ [9] ниже приведены требования к оформлению текстового материала.
5.1 Общие требования к оформлению текстового материала
Титульный лист выполняется машинописным способом. На титульном листе пояснительной записки и чертежах должен быть шифр, например:
ДП (ДР, КП, КР, ОТЧ, …) – 2068998 – && – @@ $$,
где 2068998 – шифр ОмГТУ;
&& – шифр кафедры (шифр кафедры АСОИУ – 43);
@@ – порядковый номер студента в приказе по факультету на дипломное проектирование (порядковый номер студента в списке группы);
00.00.000 – сборочные комплексы, сборочные единицы, детали;
$$ – вид чертежа или пояснительная записка.
Пояснительная записка должна быть выполнена на листах белой бумаги форматом А4 с одной стороны. Иллюстрации располагаются по тексту после ссылки на них и должны быть выполнены в соответствии с требованиями стандартов ЕСКД.
Не допускается сокращение слов в тексте, кроме общепринятых сокращений. Однотипные и многократно повторяющиеся расчёты в записке приводятся только один раз, а результаты расчетов сводятся в таблицу. Для всех вычисленных величин должны быть приведены единицы измерения.
Библиографический список оформляется в соответствии с требованиями ГОСТ.
Материал, дополняющий текст пояснительной записки, допускается помещать в приложениях.
Содержание включает наименование всех разделов, подразделов, при необходимости пунктов и подпунктов с указанием номера страниц, на которых размещается начало материала.
Текстовые документы должны быть подготовлены текстовым процессором и сданы в отпечатанном виде и на дискете (CD-диске, ином носителе). Носитель должен иметь этикетку с надписью чернилами, содержащей фамилию, инициалы студента, номер группы, название документа.
Текстовый материал должен содержать следующие структурные элементы: титульный лист, задание, техническое задание, реферат, обозначения и сокращения, содержание, введение, основную часть в соответствии с утвержденным заданием, заключение, список использованных источников, приложения. При необходимости, по согласованию с руководителем, отдельные части текстового материала могут быть опущены или добавлены.
Структурные элементы должны начинаться с нового листа. Межстрочный интервал (МСИ) должен соответствовать 1,5 интервала пишущей машинки (множитель 1,2–1,3 процессора «Word»). Текст необходимо оформлять с соблюдением следующих размеров полей: левое – 20 мм; правое – 10 мм; верхнее – 20 мм; нижнее –20 мм.
Цвет шрифта должен быть черным, высота букв, цифр и других значков – не менее 1,8 мм (кегль не менее 12). Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, теоремах, применяя шрифты разной гарнитуры. Величина абзацного отступа должна быть 10 мм.
Титульный лист (приложение А) является первой страницей документа. Перенос слов на титульном листе не разрешается, сокращения и аббревиатуры на титульном листе не допускаются.
Подписи и даты подписания выполняют только чёрным цветом. Элементы даты приводят арабскими цифрами в одной строке в последовательности: день месяца, месяц, год (напр., 10.04.2000). Сначала печатаются должности, степени и звания, затем оставляется свободное поле для подписи и помещаются инициалы и фамилии, ниже личных подписей проставляют даты подписания.
Реферат (приложение Б) должен содержать сведения об объёме отчёта, количестве иллюстраций, таблиц, приложений, количестве использованных источников. В него также включают перечень ключевых слов (от 5 до 15 слов или словосочетаний в именительном падеже прописными буквами через запятую) и текст реферата.
Содержание включает введение, наименование всех разделов, подразделов, пунктов (и при необходимости подпунктов) с наименованием, заключение, список использованных источников и наименование приложений с указанием номеров их начальных страниц. В документе объёмом не более 10 страниц содержание допускается не составлять.
Определения, обозначения и сокращения содержат уточнения терминов, перечень обозначений и сокращений, применяемых в тексте. Их запись проводят в алфавитном порядке с необходимой расшифровкой и пояснениями.
Введение должно отражать оценку современного состояния решаемой задачи, сведения об ожидаемом результате, связь работы с практическими приложениями.
Основную часть материала следует делить на разделы, подразделы, пункты и подпункты. Они нумеруются арабскими цифрами и записываются с абзацного отступа с прописной буквы без точки после цифры и на конце. Запись номера содержит сведения о разделе, подразделе, пункте и подпункте, например 1.3.2.5. Если раздел или подраздел имеет только один пункт, или пункт имеет один подпункт, то он не нумеруется. Если раздел состоит из одного подраздела, то он не нумеруется.
Разделы и подразделы должны иметь заголовки. Пункты и подпункты, как правило, также имеют заголовки. Если заголовок состоит из двух предложений, их разделяют точкой. Заголовки следует печатать с абзацного отступа с прописной буквы без точки в конце, не подчёркивая. Перенос слов в заголовках по тексту не разрешается.
Цвет шрифта должен быть черным на протяжении всего текстового документа. Нумерованные заголовки и подзаголовки должны выравниваться по левому краю с красной строки, ненумерованные по центру страницы. Заголовки, выровненные по центру, не нумеруются, например:
Содержание
Определения, обозначения и сокращения
Реферат
Введение
Список использованных источников
Приложение
Нумерация страниц – арабскими цифрами в центре нижней части листа без точки. Нумерация страниц в текстовом документе должна быть сквозной: первой страницей является титульный лист, второй – задание (далее техническое задание (ТЗ) при его наличии), затем, реферат, определения, обозначения и сокращения, содержание и т. д. На титульном листе и задании (в том числе и ТЗ, реферате, определениях, обозначениях и сокращениях) номер страницы не ставят.
Разделы текстового документа должны иметь порядковые номера в пределах всего документа. В тексте название раздела пишется без кавычек. Подразделы нумеруются арабскими цифрами в пределах каждого раздела. Номер подраздела должен состоять из номера раздела и номера подраздела, разделённых точкой (например, 2.4). Пункты и подпункты нумеруются также арабскими цифрами в пределах каждого подраздела по такой же схеме, например: 2.4.1 (первый пункт четвертого подраздела второго раздела); 2.4.1.1 (первый подпункт первого пункта четвертого подраздела второго раздела).
Внутри пунктов или подпунктов могут быть приведены перечисления. Перед каждым перечислением следует ставить дефис или строчную букву (за исключением ё, з, о, г, ь, й, ы, ъ), после которой ставится скобка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа.
Если текстовый документ содержит рисунки и таблицы, расположенные на отдельных страницах, то их необходимо включить в общую нумерацию. Приложения и список использованной литературы необходимо включать в сквозную нумерацию.
Заключение должно содержать краткие выводы по результатам работы, оценку полноты решений поставленных задач, рекомендации по использованию результатов работы, оценку технико-экономической эффективности, оценку научно-технического уровня в сравнении с лучшими достижениями в данной области.
5.1.1 Рекомендации по написанию формул
Как и любое предложение текстового документа, математическая формула имеет свой алфавит и порядок написания. Формулы, представляющие собой уравнения и неравенства, пишутся с красной строки, а связывающие их слова («где», «следовательно», «откуда», «так как» и т. п.) – в начале следующей строки без абзаца. Уравнения и формулы следует выделять в отдельную строку, выше и ниже которой может быть оставлен один межстрочный интервал.
Знаки препинания ставят на продолжении основной строки формулы, непосредственно за ней. Пример:
«Если используются несколько типов блоков, то объем памяти в байтах рассчитывается по следующей формуле:
, (3)
где VВН– объем памяти, байт;
КБ – количество блоков различного размера;
VВК – средний размер каждого типа блока, байт;
NК– количество блоков К-го типа в базе данных.
При этом количество блоков разного типа может изменяться».
Размеры символов и индексов в формуле:
V, N – 14 пт (обычный);
КБ, К = 1, ВК, К – 8 пт (крупный индекс);
S – 18 пт (крупный символ).
Буквенные обозначения, значения символов и числовых коэффициентов дают строго в той же последовательности, в которой они приведены в формуле. Расчетные формулы приводятся в общем виде с последующей подстановкой числовых значений, окончательным результатом вычислений и обязательно с указанием единиц измерения. Переносы формул на другую строку допускаются на знаках равенства (=), умножения (х), сложения (+), вычитания (−), деления (:) и других математических знаках, причём знак в начале следующей строки повторяют. При переносе формулы на знаке, символизирующем операцию умножения, применяют знак «х» (косой крест).
Формулы следует нумеровать арабскими цифрами в пределах всего текста в круглых скобках в крайнем правом положении на строке или в пределах раздела. Если в тексте одна формула, её обозначают (1). При ссылке на формулу следует указывать ее полный номер в круглых скобках, например, «в формуле (3.10)».
Формулы в приложениях нумеруются отдельно в пределах каждого приложения с добавлением перед цифрой обозначения приложения.
5.1.2 Оформление иллюстраций
Иллюстрации (чертежи, рисунки, графики, схемы, компьютерные распечатки, диаграммы, фотоснимки), в том числе цветные, следует располагать непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. Они должны соответствовать требованиям госстандартов Единой системы конструкторской документации (ЕСКД). Иллюстрации, за исключением приложений, следует нумеровать арабскими цифрами сквозной нумерацией или в пределах раздела. Иллюстрация обозначается посередине строки её номером и названием, помещённым ниже рисунка: Рисунок 1 – Детали прибора.
Иллюстрации каждого приложения обозначают нумеруют арабскими цифрами с добавлением перед цифрой обозначения приложения (например, Рисунок А.3). При необходимости под иллюстрацией помещают поясняющие данные (подрисуночный текст). Иллюстрация обозначается так: «Рисунок 1 –...», это обозначение помещают после поясняющих данных. Если в тексте только одна иллюстрация, ее обозначают так: «Рисунок 1».
Ссылки на иллюстрации имеют вид: (... на рисунке 3.18 изображено...).
Графики в зависимости от выбора системы координат строят в декартовых, прямоугольных, полярных и других координатах. Оси абсцисс и ординат графика вычерчивают сплошными линиями. Масштабирование и обозначения осей координат обязательны для любого графика, кроме качественного. Можно наносить масштаб короткими штрихами по осям.
В качественных графиках на осях координат ставятся стрелки. Числовые значения масштаба шкал осей координат пишут за пределами графика: левее оси координат и ниже оси абсцисс. По осям координат должны быть указаны условные обозначения и единицы измерения отложенных величин в принятых условных сокращениях. Следует избегать дробных значений масштабных делений по осям координат. Если кривая, изображенная на графике, занимает наибольшее пространство, то координатные оси переносят в пространство, занимаемое этой функциональной зависимостью.
При выполнении схем алгоритмов и программ используются условные графические обозначения, при этом направления линий потока сверху вниз и слева направо принимают за основные и, если эти линии потока не имеют изломов, их стрелками можно не обозначать. В остальных случаях направление линии потока обозначать обязательно.
5.1.3 Оформление таблиц
Таблицу следует располагать непосредственно после текста, в котором она впервые упоминается, или на следующей странице. Каждая таблица должна иметь порядковый номер, нумеровать следует арабскими цифрами, нумерация должна быть сквозной в пределах всего документа или раздела, за исключением приложений. Таблицы каждого приложения нумеруют отдельно арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в тексте одна таблица, она обозначается так: «Таблица 1». Название таблицы, при его наличии, следует помещать над таблицей слева без абзацного отступа в одну строку с её номером через тире. При переносе таблицы название помещают только над первой частью таблицы, нижнюю горизонтальную черту, ограничивающую таблицу, не проводят, над продолжением таблицы пишут «Продолжение таблицы» и указывают номер таблицы. При ссылке следует писать слово «таблица» с указанием её номера.
Если повторяющийся в разных строках графы таблицы текст состоит из одного слова, то его после первого написания допускается заменять кавычками; если из двух или более слов, то при первом повторении его заменяют словами «То же», а далее – кавычками. Ставить кавычки вместо повторяющихся цифр, марок, знаков, математических и химических символов не допускается. Пример оформления таблицы приведен ниже (рисунок 16).
Таблицы слева, справа и снизу, как правило, ограничивают линиями. Разграничивающие линии в таблице допускается не проводить, если их отсутствие не затрудняет пользование таблицей. Головка таблицы должна быть отделена линией от остальной части таблицы.
Таблица 3 – Статьи расходов
| Статьи | Сумма, руб. | |
| 1. | Основная заработная плата | |
| 2. | Дополнительная зарплата | |
| 3. | Отчисления в фонд соцстраха | |
| 4. | Накладные расходы | |
| 5. | Расходы по отладке | |
| Всего | 22 663 |
Рисунок 16 - Пример оформления таблицы
Заголовки граф и строк таблицы пишут с прописной буквы в единственном числе, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Допускается применять размер шрифта в таблице меньший, чем в тексте. Диагональные линии в боковике и графах таблицы не допускаются.
На все источники, помещенные в списке использованных источников, обязательно должны быть ссылки в тексте пояснительной записки (приложение В).
5.1.4 Оформление приложений
Приложения оформляются как продолжение текстового документа на последующих ее страницах либо отдельным томом. Каждое приложение начинается с новой страницы, на которой сверху посередине страницы пишется слово «Приложение», его обозначения и степени, их располагают в порядке ссылок на них в тексте. Каждое приложение имеет свое название, записываемое симметрично с прописной буквы отдельной строкой.
Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность. Одно приложение обозначается буквой А: «Приложение А».
В приложение следует выносить тот материал, который загромождает основной текст и затрудняет чтение, например распечатки, листинги, таблицы и т. п. Требования к оформлению приложения те же, что и к основному тексту.
Имеющиеся в тексте приложения иллюстрации, таблицы, формулы и уравнения следует нумеровать в пределах каждого приложения.
В заключение можно порекомендовать для самообучения электронный ресурс [10], имеющий в своём составе систему самотестирования.
Приложение А
Государственное образовательное учреждение
высшего профессионального образования
«Омский государственный технический университет»
Кафедра «Автоматизированные системы обработки информации и управления»