ТЗ на изделие в целом определяет основные направления разработки: состава, конструкции и принципа работы, а также обосновывает технические и технико-экономические характеристики. ТЗ на программное обеспечение изделия позволит установить и конкретизировать требования непосредственно к программному продукту, выработанные на основе требований основного ТЗ. ТЗ на программные изделия обычно содержит сведения о назначении и области применения ПО, технические, технико-экономические и специальные требования, стадии и сроки разработки, виды испытаний. Полная информация о требованиях к содержанию разделов и оформлению ТЗ на разработку программы или программного изделия приведена в ГОСТ 19.201-78.
Пояснительная записка составляется профессионалами в области разработки программного обеспечения и для специалистов того же уровня квалификации. Следовательно, в ней уместно использовать специальную терминологию, ссылаться на специальную литературу и т. п.
Как уже указывалось выше, в настоящее время часто используют еще один эксплуатационный документ, в который отчасти входит руководство системного программиста, программиста и оператора. Этот документ называют Руководством пользователя. Появление такого документа явилось следствием широкого распространения персональных компьютеров, работая на которых пользователи совмещают в своем лице трех указанных специалистов.
Составление документации для пользователей имеет свои особенности, связанные с тем, что пользователь, как правило, не является профессионалом в области разработки программного обеспечения. В книге С. Дж. Гримм [17] даны рекомендации по написанию подобной программной документации:
•учитывайте интересы пользователей – руководство должно содержать все инструкции, необходимые пользователю;
•излагайте ясно, используйте короткие предложения;
•избегайте технического жаргона и узко специальной терминологии, если все же необходимо использовать некоторые термины, то их следует пояснить;
•будьте точны и рациональны – длинные и запутанные руководства обычно никто не читает, например, лучше привести рисунок формы, чем долго ее описывать.
Руководство пользователя, как правило, содержит следующие разделы:
•общие сведения о программном продукте;
•описание установки;
•описание запуска;
•инструкции по работе (или описание пользовательского интерфейса);
•сообщения пользователю.
Раздел Общие сведения о программе обычно содержит наименование программного продукта, краткое описание его функций, реализованных методов и возможных областей применения.
Раздел Установка обычно содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены.
В разделе Запуск, как правило, описаны действия по запуску программного продукта и сообщений, которые при этом могут быть получены.
Раздел Инструкции по работе обычно содержит описание режимов работы, форматов ввода-вывода информации и возможных настроек.
303
Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
11.4. Руководство системного программиста
По ГОСТ 19.503–79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. Кроме того, как указывалось выше, в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505–79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508–79). В настоящее время данную схему используют для составления руководства системному администратору.
Руководство системного программиста должно содержать следующие разделы:
•общие сведения о программном продукте,
•структура,
•настройка,
•проверка,
•дополнительные возможности,
•сообщения системному программисту.
Раздел Общие сведения о программе должен включать описание назначения и функций программы, а также сведения о технических и программных средствах, обеспечивающих выполнение данной программы (например, объем оперативной памяти, требования к составу
ипараметрам внешних устройств, требования к программному обеспечению и т. п.).
Вразделе Структура программы должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
Вразделе Настройка программы должно быть приведено описание действий по настройке программы на условия практического применения.
Вразделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.
Вразделе Дополнительные возможности должно быть приведено описание дополнительных возможностей программы и способов доступа к ним.
Вразделе Сообщения системному программисту должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки и проверки программы, а также в ходе ее выполнения, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
304
11.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.
Номер формулы ставится с правой стороны страницы в круглых скобках на уровне формулы. Например:
Ссылка на номер формулы дается в скобках. Например: «расчет значений проводится по формуле (12)».
Оформление приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» прописными буквами и иметь тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д. Например:
ПРИЛОЖЕНИЕ 2
Титульный лист расчетно–пояснительной записки
Рисунки и таблицы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения с добавлением буквы «П». Например:
Рис. П. 12 – 12-й рисунок приложения; Рис. П1.2 – 2-й рисунок 1-го приложения.
Если в приложении приводится текст программы, то каждый файл оформляют как рисунок с наименованием файла и его назначением, например:
Рис. П2.4. Файл menuran.pas – программа движения курсора основного меню.
Оформление списка литературы. Список литературы должен включать все использованные источники. Сведения о книгах (монографиях, учебниках, пособиях, справочниках и т. д.) должны содержать: фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания. При наличии трех и более авторов допускается указывать фамилию и инициалы только первого из них со словами «и др.». Издательство надо приводить полностью в именительном падеже: допускается сокращение названия только двух городов: Москва (М.) и Санкт–Петербург (СПб.).
Сведения о статье из периодического издания должны включать: фамилию и инициалы автора, наименование статьи, издания (журнала), серии (ес-
307
Соседние файлы в предмете Программирование
- #
- #
- #
Руководство
32 — РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА по ГОСТ 19.503-79 (пример, образец)
- Документы
- Программные
Пример (образец) документа Руководство системного программиста по ГОСТ 19.503-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
- 32 — РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА по ГОСТ 19.503-79
- Руководство ☠ Системный ☠ Программист ☠ Пример ☠ Образец
- Открыть в новой вкладке
33 — РУКОВОДСТВО ПРОГРАММИСТА по ГОСТ 19.504-79 (пример, образец)
- Документы
- Программные
Пример (образец) документа Руководство программиста по ГОСТ 19.504-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
- 33 — РУКОВОДСТВО ПРОГРАММИСТА по ГОСТ 19.504-79
- Руководство ☠ Программист ☠ Пример ☠ Образец
- Открыть в новой вкладке
34 — РУКОВОДСТВО ОПЕРАТОРА по ГОСТ 19.505-79 (пример, образец)
- Документы
- Программные
Пример (образец) документа Руководство оператора по ГОСТ 19.505-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
- 34 — РУКОВОДСТВО ОПЕРАТОРА по ГОСТ 19.505-79
- Руководство ☠ Оператор ☠ Пример ☠ Образец
- Открыть в новой вкладке
Высшее руководство (top management) по ГОСТ ISO 9000-2011
- Терминология
Лицо или группа работников, осуществляющих руководство и управление организацией на высшем уровне [из 3.2.7 ГОСТ ISO 9000-2011]
- Из ГОСТ ISO 9000-2011 Системы менеджмента качества. Основные положения и словарь
- Management ☠ Top ☠ Высший ☠ Руководство
⇪В 17360 💥
- Открыть в новой вкладке
Высшее руководство (top management) по ГОСТ Р 54147-2010
- Терминология
Лицо или группа работников, осуществляющих направление деятельности и управление организацией на высшем уровне [из 3.2.12 ГОСТ Р 54147-2010]
- Из ГОСТ Р 54147-2010 Стратегический и инновационный менеджмент. Термины и определения
- Высший ☠ Руководство ☠ Top ☠ Management
⇪В 32354 💥
- Открыть в новой вкладке
Высшее руководство (top management) по ГОСТ Р ИСО 37100-2018
- Терминология
Лицо или группа лиц, осуществляющие руководство и управление организацией на высшем уровне.
Примечания
- Высшее руководство имеет власть делегировать полномочия и предоставлять ресурсы в рамках своей организации.
- Под высшим руководством следует понимать группу лиц в организации, отвечающую за принятие решений, которой сообщество официально или неофициально поручает имплементацию системы менеджмента.
- В случае если область применения системы менеджмента охватывает только часть организации, тогда высшее руководство относится к тем, кто руководит и управляет данной частью организации.
[из 3.3.2 ГОСТ Р ИСО 37100-2018]
- Из ГОСТ Р ИСО 37100-2018 Устойчивое развитие и адаптивность сообществ. Словарь
- Management ☠ Top ☠ Высший ☠ Руководство
⇪В 21186 💥
- Открыть в новой вкладке
Документация руководств (guidance documentation) по ГОСТ Р ИСО/МЭК 15408-1-2012
- Терминология
Документация, описывающая поставку, установку, конфигурирование, эксплуатацию, управление и (или) использование ОО (TOE) [из 3.1.36 ГОСТ Р ИСО/МЭК 15408-1-2012]
- Из ГОСТ Р 15408-1-2012 Информационная технология. Методы и средства обеспечения безопасности. Критерии оценки безопасности информационных технологий. Часть 1. Введение и общая модель
- Documentation ☠ Guidance ☠ Документация ☠ Руководство
⇪В 28372 💥
- Открыть в новой вкладке
Интерактивное электронное техническое руководство по ГОСТ Р 53394-2017
- Терминология
Обобщенное название для взаимосвязанной совокупности эксплуатационных документов, выполненных в форме интерактивного электронного документа по ГОСТ 2.051 и, как правило, содержащихся в одной общей базе данных эксплуатационной документации.
Примечание — Английский эквивалент термина «интерактивное электронное техническое руководство» — interactive electronic technical manual [из 3.40 ГОСТ Р 53394-2017]
- Из ГОСТ Р 53394-2017 Интегрированная логистическая поддержка. Термины и определения
- Интерактивный ☠ Руководство ☠ Технический ☠ Электронный
⇪В 26574 💥
- Открыть в новой вкладке
Интерактивное электронное техническое руководство, ИЭТР по ГОСТ 2.601-2013
- Терминология
Обобщенное название для взаимосвязанной совокупности эксплуатационных документов, выполненных в форме интерактивного электронного документа по ГОСТ 2.051 и, как правило, содержащихся в одной общей базе данных эксплуатационной документации [из 3.1.5 ГОСТ 2.601-2013]
- Из ГОСТ 2.601-2013 Единая система конструкторской документации. Эксплуатационные документы
- Интерактивный ☠ Электронный ☠ Технический ☠ Руководство ☠ ИЭТР
⇪В 27811 💥
⇪В 30069 💥
- Открыть в новой вкладке
Интерактивное электронное техническое руководство, ИЭТР по ГОСТ Р 54088-2017
- Терминология
Совокупность электронных документов, технических данных и программно-технических средств, предназначенная для информационного обеспечения процессов использования по назначению и технической эксплуатации изделия и (или) его составных частей и предоставляющая пользователям возможность прямой и обратной связи между пользователем и руководством в режиме реального времени с помощью интерфейса электронной системы отображения.
Примечания
- Интерактивность отражает способность электронной системы отображения информации обеспечивать диалог с пользователем через пользовательский интерфейс системы путем генерации взаимных запросов пользователем и системой и выдачей ответов на эти запросы. Интерактивность обеспечивается наличием в электронной системе отображения необходимых элементов управления (кнопки, «флажки», поля для ввода данных и т.д.).
- Английский эквивалент термина «интерактивное электронное техническое руководство» — interactive electronic technical manual.
- Программно-технические средства в составе интерактивного электронного технического руководства включают электронную систему отображения и другие необходимые средства (например, драйверы, утилиты шифрования и др.).
[из 3.1.1 ГОСТ Р 54088-2017]
- Из ГОСТ Р 54088-2017 Интегрированная логистическая поддержка. Эксплуатационная и ремонтная документация в форме интерактивных электронных технических руководств. Основные положения и общие требования
- Интерактивный ☠ ИЭТР ☠ Руководство ☠ Технический ☠ Электронный
⇪В 24360 💥
- Открыть в новой вкладке
Страницы
- 1
- 2
- 3
- следующая ›
- последняя »
Руководство системного программиста
Руководство системного программиста относится к эксплуатационно-технической документации. Документ предоставляет сведения для проверки, обеспечения функционирования и конфигурирования программы, если данные возможности обусловлены системным кодом ПО.
Во многих компаниях установка и глубокая настройка некоторых программ обычным пользователям запрещена. Данная работа входит в список обязанностей системного программиста, который проверяет логи, обеспечивает автоматическое резервное копирование данных, ведет статистику производительности и устраняет технические неполадки.
Все перечисленные функции отображаются в документе «Руководство системного программиста». Данный документ разрабатывается и оформляется в соответствии с нормативами ГОСТ 19.503-79, а также сопутствующими ГОСТ 19.101-77 (Виды программных документов) и ГОСТ 19.105-78 (Общие требования к программным документам).
Структура документа
Руководство системного программиста должно включать всю необходимую информацию, чтобы разработчик имел возможность настраивать и поддерживать функциональность программного обеспечения (системы). Типовая структура документа приведена в ГОСТ 19.503-79 и включает:
1. Общие сведения о программе.
— Описывается назначение и функции программы.
2. Структура программы.
— Составные части, компоненты, их связь и структура программы.
3. Настройка программы.
— Отображаются необходимые действия по настройке программы в конкретных условиях применения, с использованием примеров.
4. Проверка программы.
— Описываются способы проверки, которые устанавливают работоспособность программы;
5. Дополнительные возможности.
— Описание дополнительного функционала и разделов программы.
6. Сообщения системному программисту.
— Указываются тексты сообщений, которые выдаются во время проверки и настройки программы.
7. Приложения.
— Иллюстрации, графики, таблицы и примеры.
Содержание руководства
Если руководство разрабатывается на простую монолитную программу, то документ получается относительно необъемным. Однако крупные аппаратно-программные комплексы требуют описания каждого компонента, чтобы обеспечить их интеграцию, а также работоспособность со сторонним ПО.
В зависимости от типа программы и способа ее настройки также может включаться другая информация (интерфейс, утилиты командной строки, язык для скриптов и т.д.).
Оформите заявку и задавайте все интересующие вас вопросы по телефону +7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
Подборка по базе: Предпринимательская деятельность. Системный подход в управлении , Предпринимательская деятельность. Системный подход в управлении , Исполнительная власть понятие место в системе разделения властей, Внеурочное занятие по биологии. Лабораторный практикум на тему _, Тема 4.1.Физиология и гигиена сердечно-сосудистой и дыхательной , кровеносная система.pptx, КАЗ ТЕРМИНДІК СӨЗДІК-ПФ органов и систем (1).docx, бюджетная система РФ.docx, Внеурочное занятие по биологии. Лабораторный практикум на тему _, журнал учета инженерно- технических систем.docx
8. РАБОЧАЯ ДОКУМЕНТАЦИЯ
В состав рабочей, или иначе эксплуатационной, документации входят руководство пользователя, руководство оператора, руководство администратора, руководство системного администратора, руководство программиста, руководство системного программиста.
8.1. Руководство пользователя
Основной целью руководства пользователя является обеспечение пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой. Поэтому руководство пользователя должно отвечать на вопросы:
что это за программа (система)?
что может программа (система)?
что необходимо для обеспечения корректного функционирования программы (системы)?
что делать в случае отказа системы?
При составлении наиболее подробного руководства пользователя можно придерживаться следующей структуры:
1. Введение
Данный раздел должен предоставлять пользователю общую информацию о программе (системе). В нем указывают:
область применения;
краткое описание возможностей;
уровень подготовки пользователя.
51
2. Перечень эксплуатационной документации
В данном разделе перечисляется документация, которая позволит пользователю избежать определенного рода ошибок.
3. Назначение и условия применения
Раздел подразделяет основную задачу программы (системы) на подзадачи и описывает каждую из них. В нем указывают:
виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).
4. Подготовка к работе
Данный раздел должен содержать пошаговую инструкцию для запуска программы (системы). К этапу подготовки системы к работе можно отнести установку дополнительных приложений, идентификацию, аутентификацию. В данном разделе указывают:
состав и содержание дистрибутивного носителя данных;
порядок загрузки данных и программ.
5. Проверка работоспособности
В разделе описываются показатели, по которым можно определить, что программное обеспечение работает нестабильно.
6. Описание операций
Это основной раздел, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем. Если работа
52 автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе, его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе. Далее в руководстве пользователя следует представить описание функций, разбитых на отдельные операции.
Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения:
описание всех выполняемых функций, задач, комплексов задач, процедур;
описание операций технологического процесса обработки данных, необходимых для выполнения функций, задач, процедур.
7. Аварийные ситуации
В разделе описываются действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных.
8.2. Руководство оператора
Нормативной базой для составления данного документа может являться ГОСТ 19.505-79 «ЕСПД. Руководство оператора. Требования к содержанию и оформлению», в котором выделяются следующие разделы:
назначение программы (сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации);
53
условия выполнения программы (минимальный и/или максимальный состав аппаратурных и программных средств и т. д.);
выполнение программы
(последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды);
сообщения оператору (тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора в случае сбоя, возможности повторного запуска программы и т. п.).
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
В общем случае руководство оператора отличается от руководства пользователя. В руководстве оператора все процессы, выполняемые программным обеспечением, рассматриваются с технической точки зрения. Исходя из этого, можно представить альтернативную структуру данного руководства:
1. Установка на сервер
В разделе описывается процесс установки программного обеспечения на сервер. Пошаговая инструкция дает точные указания, каким образом необходимо выполнить установку, в зависимости от технического состояния сервера.
54
2. Установка локальная
В разделе описывается процесс настройки компьютеров, использующих программное приложение, также даются рекомендации по оптимизации настройки рабочих станций, чтобы улучшить процесс взаимодействия сервера и компьютеров пользователей.
3. Администрирование пользователей
В разделе подробно описывается процесс администрирования учетных записей пользователей программного обеспечения.
Подробная инструкция описывает все ситуации, которые могут возникнуть при управлении пользователями. Например, можно централизованно завершать все активные соединения с информационной базой и устанавливать блокировку новых соединений на определенный период времени. Такая возможность полезна при выполнении различных административных действий с информационной базой.
4. Информационная база
В разделе рассматриваются вопросы администрирования, сохранения, переноса базы данных. Описаны рекомендации по настройке базы данных. Например, рассматривается ситуация резервного копирования. Резервное копирование может выполняться как в автоматическом режиме, так и в ручном. Для автоматического режима предварительно необходимо выполнить настройки. В любой момент можно восстановить данные информационной базы из созданной ранее резервной копии.
5. Технические неполадки
Этот раздел содержит информацию о возможных технических проблемах, которые могут возникнуть в процессе эксплуатации программного обеспечения.
Рассматриваются проблемы, возникающие в результате некорректной работы оборудования, а
55 также ситуации, возникающие в результате некорректного использования функций программного обеспечения.
6. Программный код
В разделе подробно описывается структура программного кода.
Если в процессе использования программного обеспечения возникают ошибки или потребуется доработка, то для этого необходимо знать программный код. Указываются особенности программного кода, создающие затруднения в процессе доработки. Раздел является очень важным, так как может потребоваться добавить, удалить или изменить определенные функции программного обеспечения.
8.3. Руководство администратора
Обычно администратор считается пользователем системы, при этом он наделен как особыми обязанностями, так и необходимыми для их выполнения привилегиями. По методике и стилю изложения руководство администратора похоже на руководство пользователя.
При этом, как правило, описание в нем строится от задач, а не от функций.
Работа администратора многопользовательской системы, как правило, заключается в управлении учетными записями других пользователей, предоставлении им полномочий на доступ к данным и выполнение операций, а также в исправлении сделанных ими ошибок.
Например, бывают автоматизированные системы, в которых вводить и редактировать данные может любой пользователь, а удалять – только администратор. Кроме того, администратор может заниматься ведением нормативно-справочной информации, загрузкой и выгрузкой данных, открытием и закрытием расчетных периодов и т. п. С этой точки зрения руководство администратора является системным документом и приобретает смысл только в условиях конкретной системы с живыми пользователями.
56
Системы часто создаются на основе тиражируемых программных продуктов или аппаратно-программных комплексов. В составе таких решений нередко поставляется программный компонент под названием «Администратор», предназначенный для управления системой после ее развертывания.
Структура руководства администратора существенным образом зависит от того, как устроена система, и какого обслуживания она требует.
Типичная структура руководства администратора системы следующая:
1. Назначение системы
2. Принципы функционирования системы
3. Обязанности и задачи администратора
4. Обслуживание системы
настройка параметров работы системы;
ведение нормативно-справочной информации;
учетные записи пользователей и управление ими;
назначение пользователям прав доступа;
загрузка и выгрузка данных.
5. Проблемы в работе системы и способы их решения
Руководство по административному модулю программного или программно-аппаратного комплекса содержит примерно те же сведения, но в более общем виде. Например, в нем должно быть объяснено, как создать учетную запись пользователя, но не может быть указано, когда это следует делать. Такая конкретика возникает только при внедрении продукта в некотором конкретном месте и отражается в технологических инструкциях или регламентах.
57
Структура руководства по административному модулю программного или аппаратно-программного комплекса может иметь следующий вид:
1. Общие сведения о комплексе
2. Функционирование комплекса в рамках системы
(рассматриваются несколько наиболее типичных случаев применения комплекса и перечисляются основные обязанности администратора в каждом из них)
3. Интерфейс пользователя административного модуля
4. Задачи по обслуживанию
настройка параметров работы системы;
ведение нормативно-справочной информации;
учетные записи пользователей и управление ими;
назначение пользователям прав доступа;
загрузка и выгрузка данных.
5. Типичные проблемы в работе и способы их решения
Руководство администратора не следует путать с руководством системного администратора. Первый документ говорит о том, как организовать и поддерживать целевое применение системы, второй – как обеспечить ее техническую работоспособность.
8.4. Руководство системного администратора
Руководство системного администратора – вспомогательный документ для прикладных программных продуктов и основной для серверных и системных, не имеющих непосредственных пользователей.
В случае небольших «монолитных» программ руководство системного администратора может оказаться документом небольшим
58 по объему и простым по структуре. Руководство системного администратора на программный или аппаратно-программный комплекс, как правило, ощутимо сложнее, поскольку в нем приходится описывать каждый компонент по отдельности и способы их интеграции как друг с другом, так и со сторонним программным обеспечением: серверами баз данных, почтовыми серверами, антивирусами, средствами шифрования и пр.
В руководстве системного администратора должны быть изложены:
назначение и область применения программы (или комплекса);
состав программы, основные принципы ее функционирования;
комплект поставки (если он не указан в отдельном документе);
системные требования для программы или ее компонентов;
предпочтительная очередность установки компонентов;
процедура установки программы или каждого ее компонента;
порядок обязательной первоначальной настройки программы;
способы интеграции установленных копий компонентов между собой;
интеграция программы со сторонним ПО, например, с сервером базы данных;
способы и периодичность контроля правильности работы программы;
порядок текущего обслуживания работающих копий программы;
59
порядок решения всевозможных вспомогательных задач;
аварийные ситуации и способы их устранения.
Кроме того, в руководстве системного администратора могут быть описаны:
пользовательский интерфейс административной консоли;
утилиты командной строки и синтаксис их запуска;
конфигурационные файлы и правила их написания;
язык для составления управляющих скриптов.
Все зависит от того, какие средства для установки и настройки программы реализовали ее разработчики, какие именно инструменты есть у системного администратора.
Методика изложения материала в руководстве системного администратора сильно зависит от того, каким образом программой можно управлять. Если большинство задач решается через административную консоль с графическим интерфейсом, то документ будет больше похож на руководство пользователя или руководство администратора. Если системному администратору придется составлять конфигурационные файлы и писать скрипты, документ будет ближе к руководству программиста.
Приблизительная структура руководства системного администратора следующая:
1. Общие сведения о программе (комплексе)
2. Архитектура и принципы функционирования
3. Системные требования
4. Установка программы (комплекса)
5. Административная консоль и работа с ней
60
6. Файл конфигурации. Составление и правка
7. Обязательная
начальная
настройка
программы
(комплекса)
8. Проверка правильности функционирования программы
(комплекса)
9. Мероприятия по текущему обслуживанию программы
(комплекса)
10. Оптимизация работы программы (комплекса)
11. Аварийные ситуации и способы их устранения
Объем и особенности изложения информации в руководстве системного администратора зависят от используемых технических средств (ПК, серверных комплексов, планшетов, периферийных устройств и т. д.), применяемого программного обеспечения и решаемых с его помощью конкретных задач.
8.5. Руководство программиста
Программист – это специалист, который занимается разработкой алгоритмов и компьютерных программ на основе специальных математических моделей. Прикладные программисты занимаются в основном разработкой программного обеспечения прикладного характера, а также в их обязанности входит адаптация уже существующих программ под нужды отдельно взятой организации или пользователя.
Нормативной базой для составления данного документа может являться ГОСТ 19.504-79 «ЕСПД. Руководство программиста.
Требования к содержанию и оформлению», в котором выделяются следующие разделы:
61
назначение и условия применения программы (назначение и функции, выполняемые программой, объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т. п.);
характеристики программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.);
обращение к программе (описание процедур вызова программы, способы передачи управления и параметров данных и др.);
входные и выходные данные (описание организации используемой входной и выходной информации и, при необходимости, ее кодирования);
сообщения (тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям).
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).
8.6. Руководство системного программиста
Системный программист – это разработчик операционных систем, программных комплексов, обеспечивающих слаженную работу компонентов компьютера, который практически не занимается прикладными программами. Системный программист выстраивает многоуровневую структуру, которая объединяет отдельные компоненты
(работу процессора, сетевого оборудования,
62 оперативную память, выполнение прикладных программ и пр.) в модули, а модули – в компьютерную сеть.
Нормативной базой для составления данного документа может являться ГОСТ 19.503-79 «ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению», в котором выделяются следующие разделы:
общие сведения о программе (назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы);
структура программы (сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами);
настройка программы (описание действий по настройке программы на состав технических средств, выбор функций и др.);
проверка программы
(описание способов проверки, позволяющих дать общее заключение о работоспособности программы: контрольные примеры, методы прогона, результаты);
дополнительные возможности (описание дополнительных разделов функциональных возможностей программы и способов их выбора);
сообщения системному программисту (тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям).
63
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).
Вопросы для самоконтроля:
1. Для чего необходимо руководство пользователя?
2. Чем руководство оператора отличается от руководства пользователя?
3. Что включает в себя руководство программиста?
Системный программист
Cтраница 2
Первые достижения системных программистов ( тогда их так еще не называли) связаны с появлением ЭВМ первого поколения.
[16]
Рассчитана на системных программистов и тех, кто разрабатывает и эксплуатирует программное и аппаратное обеспечение ЭВМ.
[17]
В руководстве системного программиста приводятся сведения о действиях, которые необходимо провести для привязки системы к конкретной задаче пользователя и конфигурации ЭВМ для ее реализации. Если в процессе привязки предполагается генерация программной системы, в данном руководстве должны быть приведены сведения о ее проведении. Поскольку система предоставляет широкие возможности реализации различных вариантов привязки, в руководство следует включать рекомендации, обеспечивающие эффективную работу программы ( или системы программ) в условиях ее конкретного применения.
[18]
Конструктор позволяет системному программисту вводить программы на языке ЯОС, редактировать их, транслировать, вносить в базу знаний, строить таблицу процессов, загружать и сохранять файлы, содержащие тексты программ на ЯОС, а также загружать и сохранять базу знаний. Таким образом, основная задача конструктора заключается в предоставлении сервиса при создании базы знаний. В конструктор внесены также специальные механизмы для ввода речевых сообщений и сохранения введенных цифровых речевых образов в файлах на диске.
[19]
В инструкции системному программисту излагаются рекомендации по расширению и развитию системы. Если система снабжена хорошей технической документацией, то эта инструкция может отсутствовать.
[20]
ОС разрабатываются системными программистами и представляют собой организованную совокупность программ, реализующих сложные алгоритмы управления функционированием ЭВМ. Эти программы, по сути дела, скрывают от пользователя всю сложность вычислительных машин. Для работы с ЭВМ достаточно знать возможности ОС, предоставляемые пользователю в виде некоторого языка взаимодействия с ней. Перечень ( состав) этих команд ОС и составляет правила вождения вычислительной машины, а правила и особенности их применения являются правилами дорожного движения в системе. Без знания первых вы не сможете работать с ЭВМ, а несоблюдение вторых может привести к аварии, например уничтожению очень нужной программы.
[21]
Традиционно реализацию выполняет системный программист высокого класса, консультируясь у инженера по знаниям.
[22]
Под непосредственным контролем системного программиста находятся только две части общего времени обслуживания прерывания, а именно программные части времени разрешения и времени восстановления. Он может воздействовать также на время программы прерывания, если программа поставляется вместе с ОС. Если же программу пишет пользователь, то системный программист, разумеется, никак не может повлиять на время реакции системы. Поэтому следует уделять больше внимания тем частям процедуры обслуживания прерываний, которые находятся под контролем разработчика.
[23]
Основными языками общения системного программиста с СВМ ЕС являются язык команд МВМ и язык команд ПДО.
[24]
В отличие от системного программиста, который может подобрать метод сортировки, наилучшим образом соответствующий данному частному приложению, случайный пользователь может обойтись одной стандартной процедурой сортировки.
[25]
ПАД предоставляет для системного программиста важное вспомогательное средство для регистрации, оценки и обработки ошибок, возникающих при работе СВМ ЕС.
[26]
Тематика упражнений для системного программиста связана с конструированием описания физических и логических БД средствами языка описания данных, описанием и генерацией блоков связи прикладных программ с базами данных.
[27]
В отличие от системного программиста, который может подобрать метод сортировки, наилучшим образом соответствующий данному частному приложению, случайный пользователь может обойтись одной стандартной процедурой сортировки.
[28]
На основании решения системного программиста оператор либо вводит новые системные параметры с помощью команды REPLY, либо оставляет параметры, которые были заданы при генерации.
[29]
В разделе Сведения системному программисту должны быть приведены инструкции по настройке программы, указаны структура программы, а также необходимые данные, позволяющие системному программисту подключать задачу к другим задачам, решаемым в рамках ППП АБИС или на вычислительном центре организации, в которую входит библиотека или информационная служба.
[30]
Страницы:
1
2
3
4