11.2. Руководство пользователя

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

• назначение программы;

• условия выполнения программы;

• выполнение программы;

• сообщения оператору.

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

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

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

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

В разделе «Сообщения оператору» должны быть приведены:

• тексты сообщений, выдаваемых в ходе выполнения программы;

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

11.3. Руководство системного администратора

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

• общие сведения о программе;

• структура программы;

• настройка программы;

• проверка программы;

• дополнительные возможности;

• сообщения системному программисту.

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

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

В разделе «Общие сведения о программе» должны быть указаны:

• назначение и функции программы;

• сведения о технических и программных средствах, обеспечивающих выполнение данной программы.

В разделе «Структура программы» должны быть приведены:

• сведения о структуре программы, ее составных частях;

• сведения о связях между составными частями;

• сведения о связях с другими программами.

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

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

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

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

В разделе «Сообщения системному программисту» должны быть указаны:

• тексты сообщений, выдаваемых в ходе выполнения настройки, проверки и выполнения программы;

• описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

12. Требования по оформлению пояснительной записки

Все текстовые документы оформляются по ГОСТ 7.32-2001 и должны соответствовать РД 40-050-87.

Текстовый материал должен содержать следующие структурные элементы: титульный лист, задание (в том числе техническое задание), реферат, содержание, обозначения и сокращения, введение, основную часть в соответствии с утвержденным заданием, заключение, список использованных источников, приложения. При необходимости по согласованию с преподавателем отдельные части текстового материала могут быть опущены или добавлены. Структурные элементы должны начинаться с нового листа. В основной части только заголовок раздела отделяется сверху и снизу межстрочным интервалом (МСИ). Межстрочный интервал машинописного текста – полуторный (множитель 1,2 процессора "Word").

Текст необходимо оформлять с соблюдением следующих размеров полей: левое – 20 мм; правое – 10 мм; верхнее – 20 мм; нижнее – 20 мм. Страницы текста и иллюстрации должны соответствовать формату А4.

Текст должен быть выполнен с использованием компьютера и принтера на одной стороне листа белой бумаги. Цвет шрифта должен быть черным, высота букв, цифр и других значков – не менее 1,8 мм (кегль не менее 12). Разрешается использовать компьютерные возможности акцентирования внимания на определенных терминах, формулах, теоремах, применяя шрифты разной гарнитуры. Величина абзацного отступа должна быть 10 мм.

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

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

Примеры оформления титульного листа приведены в приложениях Б-Я.

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

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

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

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

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

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

Содержание

Перечень условных обозначений

Введение

Список использованных источников

Приложение

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

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

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

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

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

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

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

Иллюстрации (чертежи, рисунки, графики, схемы, компьютерные распечатки, диаграммы, фотоснимки), в том числе и цветные, следует располагать непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. Они должны соответствовать требованиям госстандартов Единой системы конструкторской документации (ЕСКД). Иллюстрации, за исключением приложений, следует нумеровать арабскими цифрами сквозной нумерацией или в пределах раздела. Иллюстрация обозначается посередине строки её номером и названием: Рис. 1. Детали прибора.

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

При выполнении схем алгоритмов и программ используются условные графические обозначения по ГОСТ 19.003-80. При этом направления линий потока сверху вниз и слева направо принимают за основные и, если эти линии потока не имеют изломов, то их стрелками можно не обозначать. В остальных случаях направление линии потока обозначать обязательно.

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