tehnologia (1018792), страница 50
Текст из файла (страница 50)
п.11.3. Руководство пользователяКак уже указывалось выше, в настоящее время часто используют еще одинэксплуатационный документ, в который отчасти входит руководство системногопрограммиста, программиста и оператора. Этот документ называют Руководствомпользователя. Появление такого документа явилось следствием широкого распространенияперсональных компьютеров, работая на которых пользователи совмещают в своем лице трехуказанных специалистов.Составление документации для пользователей имеет свои особенности, связанные стем, что пользователь, как правило, не является профессионалом в области разработкипрограммного обеспечения. В книге С.
Дж. Гримм [17] даны рекомендации по написаниюподобной программной документации:• учитывайте интересы пользователей – руководство должно содержать всеинструкции, необходимые пользователю;• излагайте ясно, используйте короткие предложения;• избегайте технического жаргона и узко специальной терминологии, если все женеобходимо использовать некоторые термины, то их следует пояснить;• будьте точны и рациональны – длинные и запутанные руководства обычно никто нечитает, например, лучше привести рисунок формы, чем долго ее описывать.Руководство пользователя, как правило, содержит следующие разделы:• общие сведения о программном продукте;• описание установки;• описание запуска;• инструкции по работе (или описание пользовательского интерфейса);• сообщения пользователю.Раздел Общие сведения о программе обычно содержит наименование программногопродукта, краткое описание его функций, реализованных методов и возможных областейприменения.Раздел Установка обычно содержит подробное описание действий по установкепрограммного продукта и сообщений, которые при этом могут быть получены.В разделе Запуск, как правило, описаны действия по запуску программного продукта исообщений, которые при этом могут быть получены.Раздел Инструкции по работе обычно содержит описание режимов работы, форматовввода-вывода информации и возможных настроек.303Раздел Сообщения пользователю должен содержать перечень возможных сообщений,описание их содержания и действий, которые необходимо предпринять по этим сообщениям.11.4.
Руководство системного программистаПо ГОСТ 19.503–79 руководство системного программиста должно содержать всюинформацию, необходимую для установки программного обеспечения, его настройки ипроверки работоспособности. Кроме того, как указывалось выше, в него часто включают иописание необходимого обслуживания, которое раньше приводилось в руководствеоператора (ГОСТ 19.505–79) и/или руководстве по техническому обслуживанию (ГОСТ19.508–79).
В настоящее время данную схему используют для составления руководствасистемному администратору.Руководство системного программиста должно содержать следующие разделы:• общие сведения о программном продукте,• структура,• настройка,• проверка,• дополнительные возможности,• сообщения системному программисту.Раздел Общие сведения о программе должен включать описание назначения и функцийпрограммы, а также сведения о технических и программных средствах, обеспечивающихвыполнение данной программы (например, объем оперативной памяти, требования к составуи параметрам внешних устройств, требования к программному обеспечению и т.
п.).В разделе Структура программы должны быть приведены сведения о структурепрограммы, ее составных частях, о связях между составными частями и о связях с другимипрограммами.В разделе Настройка программы должно быть приведено описание действий понастройке программы на условия практического применения.В разделе Проверка программы должно быть приведено описание способов проверкиработоспособности программы, например контрольные примеры.В разделе Дополнительные возможности должно быть приведено описаниедополнительных возможностей программы и способов доступа к ним.В разделе Сообщения системному программисту должны быть указаны текстысообщений, выдаваемых в ходе выполнения настройки и проверки программы, а также входе ее выполнения, описание их содержания и действий, которые необходимо предпринятьпо этим сообщениям.30411.5.
Основные правила оформления программной документацииПри оформлении текстовых и графических материалов, входящих в программнуюдокументацию следует придерживаться действующих стандартов. Некоторые положенияэтих стандартов приведены ниже.Оформление текстового и графического материала. Текстовые документыоформляют на листах формата А4, причем графический материал допускается представлятьна листах формата A3. Поля на листе определяют в соответствии с общими требованиями:левое – не менее 30, правое – не менее 10, верхнее – не менее 15, а нижнее – не менее 20 мм.В текстовых редакторах для оформления записки параметры страницы заказывают взависимости от устройства печати.
При ручном оформлении документов параметрыстраницы выбирают из соображений удобства.Нумерация всех страниц – сквозная. Номер проставляется сверху справа арабскойцифрой. Страницами считают, как листы с текстами и рисунками, так и листы приложений.Первой страницей считается титульный лист. Номер страницы на титульном листе непроставляют.Наименование разделов пишут прописными буквами в середине строки.
Расстояниемежду заголовками и текстом, а также между заголовками раздела и подразделов должнобыть равно:• при выполнении документа машинописным способом – двум интервалам;• при выполнении рукописным способом – 10 мм;• при использовании текстовых редакторов – определяется возможностями редактора.Наименования подразделов и пунктов следует размещать с абзацного отступа ипечатать вразрядку с прописной буквы, не подчеркивая и без точки в конце. Расстояниемежду последней строкой текста предыдущего раздела и последующим заголовком прирасположении их на одной странице должно быть равно:• при выполнении документа машинописным способом – трем интервалам;• при выполнении рукописным способом – не менее 15 мм;• при использовании текстовых редакторов – определяется возможностями редактора.Разделы и подразделы нумеруются арабскими цифрами с точкой.
Разделы должныиметь порядковые номера 1, 2, и т. д. Номер подраздела включает номер раздела ипорядковый номер подраздела, входящего в данный раздел, разделенные точкой. Например:2.1, 3.5. Ссылки на пункты, разделы и подразделы указывают, используя порядковый номерраздела или пункта, например, «в разд. 4», «в п. 3.3.4».305Текст разделов печатают через 1,5-2 интервала. При использовании текстовыхредакторов высота букв и цифр должна быть не менее 1,8 мм (шрифты № 11-12).Перечисления следует нумеровать арабскими цифрами со скобкой, например: 2), 3) ит.д.
– с абзацного отступа. Допускается выделять перечисление простановкой дефиса передпунктом текста или символом, его заменяющим, в текстовых редакторах.Оформление рисунков, схем алгоритмов, таблиц и формул. В соответствии с ГОСТ2.105–79 «Общие требования к текстовым документам» иллюстрации (графики, схемы,диаграммы) могут быть приведены как в основном тексте, так и в приложении. Всеиллюстрации именуют рисунками. Все рисунки, таблицы и формулы нумеруют арабскимицифрами последовательно (сквозная нумерация) или в пределах раздела (относительнаянумерация).
В приложении – в пределах приложения.Каждый рисунок должен иметь подрисуночную подпись – название, помещаемую подрисунком, например:Рис.12. Форма окна основного менюНа все рисунки, таблицы и формулы в записке должны быть ссылки в виде: «(рис. 12)»или «форма окна основного меню приведена на рис. 12».Если позволяет место, рисунки и таблицы должны размещаться сразу после абзаца, вкотором они упоминаются в первый раз, или как можно ближе к этому абзацу на следующихстраницах.Если рисунок занимает более одной страницы, на всех страницах, кроме первой,проставляется номер рисунка и слово «Продолжение». Например:Рис.
12. ПродолжениеРисунки следует размещать так, чтобы их можно было рассматривать без поворотастраницы. Если такое размещение невозможно, рисунки следует располагать так, чтобы дляпросмотра надо было повернуть страницу по часовой стрелке. В этом случае верхним краемявляется левый край страницы. Расположение и размеры полей сохраняются.Схемы алгоритмов должны быть выполнены в соответствии со стандартом ЕСПД.Толщина сплошной линии при вычерчивании схем алгоритмов должна составлять от 0,6...1,5мм.
Надписи на схемах должны быть выполнены чертежным шрифтом, высота букв и цифрдолжна быть не менее 3,5 мм.Номер таблицы размещают в правом верхнем углу или перед заголовком таблицы, еслион есть. Заголовок, кроме первой буквы, выполняют строчными буквами.Ссылки на таблицы в тексте пояснительной записки указывают в виде слова «табл.» иномера таблицы. Например:306Результаты тестов приведены в табл. 4.Номер формулы ставится с правой стороны страницы в круглых скобках на уровнеформулы. Например:z : = sin(x)+ln(y);(12)Ссылка на номер формулы дается в скобках.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
