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

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

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

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста», определенного ГОСТ 19.101-77.

Стандарт полностью соответствует CТ СЭВ 2094-80.

1.1. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

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

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

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

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

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

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

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

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

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

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

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

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

По ГОСТ 19.503—79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. Кроме того, как указывалось выше, в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505—79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508—79). В настоящее время данную схему используют для составления руководства системному администратору.

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

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

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

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

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

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

В разделе Проверкапрограммы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.

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

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

Назовите виды программных документов.

Каксоставляется пояснительная записка?

Какимобразом составляется руководство пользователя?

Каксоставляется руководство системного администратора?

РАЗРАБОТКА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

Руководство программиста на программное обеспечение и автоматизированную систему

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

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

Примерами могут служить:

– платформа или среда для разработки ПО;

– ПО с открытым кодом.

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

– назначение, структуру входных и выходных данных программных функций;

– возможности по созданию программного кода, особенности его интерпретации и компиляции;

– синтаксические особенности используемого языка программирования;

– возможные правила и ограничения при работе с программным кодом;

– различные инструкции по работе с программой.

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

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

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

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

– Обращение к программе. где указывают способы и параметры запуска программы;

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

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

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

ГОСТы регламентируют и этот документ, в данном случае это ГОСТ 19.504. В соответствии с ним определяется структура и содержание Руководства программиста.

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

РУКОВОДСТВО СИСТЕМНОМУ ПРОГРАММИСТУ

В программе предусмотрено формирование запросов к базе данных и выдача отчетов. Для корректной работы программы требуются: компьютер семейства IBM PC с процессором Intel Pentium 1.5 GHz. 500 Мб свободного места на жестком диске и 128 Мб оперативной памяти. Операционная система MS Windows XP/Vista/7. Сетевой адаптер и принтер. Так же необходимо установить актуальную версию MySQL server.

Минимальные системные требования

Аппаратные требова ния:

Не менее 4х персональных компьютеров семейства IBM PC, объединенных в локальную сеть;

Процессор 1 гигагерц (ГГц) или выше с поддержкой PAE, NX и SSE2;

Не менее 128 МБ оперативной памяти; модель (смалл медиум и др и сколько нам нужно из этой свободной);

Не менее 500 MБ свободной памяти на жестком диске персонального компьютера АРМ «Системный администратор» для хранения БД и программного обеспечения, ине менее 50 МБ на персональных компьютерах автоматизированных рабочих мест сотрудников общего отдела, учителей, учеников;

Мониторы 19” 1280х1024, цветные;

Видеокарты, обеспечивающие цветовую гамму 32 bit или более;

Устройства манипуляции (мыши).

Один или более принтеров HP, Canon или других моделей, включенных в сеть.

- Операционная система Windows XP и выше;

- Среда разработки Borland Delphi 7 или выше и язык программирования Delphi;

Cистема управления базами данных MySQL Workbench и язык запросов MySQL;

Программа для работы с электронными таблицами Microsoft Exel;

Программа Microsoft Power Point;

Текстовый редактор Microsoft Word.

Сетевое программное обеспечение.

Автоматизированная система управления «Школа» состоит из следующий рабочих мест

Автоматизированное рабочее место системного администратора

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

В программе предусмотрено формирование запросов к базе данных и выдача отчетов.

Программа состоит из четырех модулей:

«log.pas» — диалог ввода логина и пароля пользователя.

«main.pas» — главное окно.

«help.pas» — окно «Справка».

«prev.pas» — окно для формирования отчетов.

Автоматизированное рабочее место учителя

Назначение и условия применения

Данная задача предназначена для автоматизации работы школьного учителя с данными. Решение задачи призвано обеспечить:

быструю и удобную обработку данных;

исключение ошибок при выполнении работы ручным способом.

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

Вывод расписания и внеклассных занятий (кружки, секции и тп.);

Вывод классного журнала;

Создание учебного плана;

Вывод информации об успеваемости и пропусках ученика;

Редактирование электронной библиотеки;

Формирование отчётов с выводом на печать.

Процедуры и функции:

Авторизация состоит из процедур:

TAFT.LoginClick(Sender: TObject) – события Click на поле логин;

TAFT.LoginExit(Sender: TObject) – потеря фокуса (логин);

TAFT.LoginExit(Sender: TObject) – потеря фокуса (логин);

TAFT.LoginExit(Sender: TObject) – потеря фокуса (логин);

TAFT.LoginKeyPress(Sender: TObject; var Key: Char) – ввод логина;

TAFT.PasKeyPress(Sender Char) – ввод пароля не показывая введенные символы;

Главная форма состоит из процедур:

TTeacher.AcsesBd( string) – процедура подключения таблицы из БД;

TTeacher.Spisok) – процедура заполнения раскрывающегося списка;

TTeacher.Dupl(Box: TComb) – процедура убирающая дубликаты из боксов;

TTeacher.Clear – процедура очистки оценок и Н-ок;

TTeacher.InsertDB(ADO) – процедура добавления данных в БД;

TTeacher.FormCreate(Sener: TOject) – действия при открытии формы;

TTeacher.Image1Click(Snder: TObjet) – добавление объявления в БД;

TTeacher.Image6Click(Se) – возвращение в рабочую область каталог;

TTeacher.JornalTClick(Sender: TObject) – выставление Н-ок и оценок;

TTeacher.jornClick(Sender: TObject) – журнал;

TTeacher.SaveClick(Sender: TObject) – сохранить оценки в журнале;

TTeacher.SAVEOBClick(Sender: T) – добавление нового объявления;

TTeacher.N11Click(Sender: TObject) – выставление оценок;

TTeacher.DeleteClick(Sender: TObject) – удаление данных в журнале за выбранный период;

Автоматизированное рабочее место ученика

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

Вывод следующих данных на экран:

Поиск по ключам.

Формирование отчётов и справок.

Выдача отчётов и справок на экран и печать.

Возможность сохранения отчёта в файл.

Программа состоит из одного основного модуля ucheniki.dpr, ucheniki.pas и стандартных модулей: Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, Dialogs, ExtCtrls, ComCtrls, TabNotBk, StdCtrls, Grids, Imaging.jpeg, Imaging.pngimage, CheckLst, DBGrids, FMTBcd, DB, DBClient, Provider, SqlExpr, DBXMySQL, ADODB, IniFiles.

ShowMessage — процедура вывода простого диалогового окна на экране с кнопкой ОК, содержащее строку указанную в параметре;

FieldByName — процедура для получения значения поля по его имени из таблицы;

SQL.Clear — процедура очистки sql запроса;

SQL.Add — процедура добавления sql запроса;

Next – процедура перехода к следующей записи таблицы;

Create — процедура создающая экземпляр TIniFile, который позволяет манипулировать INI-файлом;

Free — процедура освобождающая память, выделенную под экземпляр TiniFile;

ReadString — процедура для считывания строкового параметра из INI-файла;

FormCreate — обработчик события OnCreate;

FormDestroy — обработчик события OnDestroy;

ButtonQuitClick — обработчик события нажатия на кнопку ButtonQuit;

TabbedNotebook1Click — обработчик события выбора на вкладки компонента TabbedNotebook1;

TabbedNotebook2Click — обработчик события выбора на вкладки компонента TabbedNotebook2.

Автоматизированное рабочее место сотрудника общего отдела

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

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

Редактирование личных дел учителей и учеников;

Вывод успеваемости и посещаемости уроков;

Редактирование расписания уроков и кружков для учителей и учеников

Формирование отчетности по успеваемости уроков по периодам (четверть, полугодие. год).

Программа состоит из основного загрузочного модуля ARM4.exe и модулей:

Unit1 – форма авторизации

Unit2 – главная форма программы

Unit3 – форма заполнения расписания

Unit4 – форма добавления нового предмета

Unit5 – форма добавления нового кружка

N1Click — выбор пункта « Личные дела работников».

N2Click — выбор подпункта «Личные данные и контактая информация»

N3Click — выбор подпункта «Состав семьи»

N4Click — выбор подпункта «Нагрузка»`

N5Click — выбор пункта « Личные дела учеников».выбор подпункта

N6Click — выбор пункта « Личные дела учеников».

N7Click — выбор подпункта «Личные данные»

N8Click — выбор подпункта «Сведения о семье»

N9Click — выбор подпункта «Внеурочная занятость»

N10Click — выбор подпункта «Достижения »

N11Click — выбор подпункта «Пропуски»

N12Click — выбор пункта «Расписание учителей»

N13Click — выбор пункта «Расписание учеников»

N14Click — выбор пункта «Расписание кружков»

N15Click — выбор пункта «Поиск»

N16Click — выбор подпункта «Отчеты»

N17Click — выбор подпункта «Успеваемость»

N18Click — выбор подпункта «Пропуски»

N19Click — выбор подпункта «Список класса»

N20Click — выбор подпункта «Список учителей»

N21Click — выбор подпункта «Справка-подтверждение»

Unit1.pas – осуществляет авторизацию пользователя системы

Button1Click — обработка нажатия кнопки «Вход» для входа в систему

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

Button2Click — обработка нажатия кнопки «Новая запись» для создания нового личного дела учителя

Button3Click — обработка нажатия кнопки «Новая запись» для создания нового личного дела ученика

Button4Click — обработка нажатия кнопки «Удалить запись» для удаления личного дела учителя

Button5Click — обработка нажатия кнопки «Удалить запись» для удаления личного дела ученика.

Button6Click — обработка нажатия кнопки «Редактирование» для внесения изменений в личное дело учителя

Button7Click — обработка нажатия кнопки «Редактирование» для внесения изменений в личное дело ученика

Button8Click — обработка нажатия кнопки «Редактирование» для внесения изменений в личное дело учителя

Button9Click — обработка нажатия кнопки «Редактирование» для внесения изменений в расписание учителя

Button10Click — обработка нажатия кнопки «Редактирование» для внесения изменений в расписание ученика

Button11Click — обработка нажатия кнопки «Редактирование» для внесения изменений в расписание кружков

Button12Click — обработка нажатия кнопки «Поиск» для поиска информации по заданному ключу

Button13Click — обработка нажатия кнопки «Отмена поиска» для очистки критериев поиска

Button14Click — обработка нажатия кнопки «Печать» для печати выбранного отчета

Unit3.pas – осуществляет заполнение и внесение изменений в расписание учителей, учеников, кружков.

Button15Click — обработка нажатия кнопки «Сохранить» для сохранения данных в базу данных

Button16Click — обработка нажатия кнопки «Отмена»

Unit4.pas – осуществляет добавление нового предмета в базу данных

Button17Click — обработка нажатия кнопки «Сохранить» для сохранения данных в базу данных

Button18Click — обработка нажатия кнопки «Отмена»

Unit5.pas – осуществляет добавление нового кружка в базу данных

Button19Click — обработка нажатия кнопки «Сохранить» для сохранения данных в базу данных

Button20Click — обработка нажатия кнопки «Отмена»

В файле config.ini в папке с программой необходимо в секции ServerConfig указать параметры:

ServerIP — IP адрес сервера с базой данных,

NameOfDB — название базы данных (armschool),

PortOfServer — порт, по которому сервер обрабатывает запросы к базе данных

Пример содержания файла config.ini:

Правильность работы программы доказана в разделе «Контрольный пример».

01 32 01 (Руководство системного программиста)

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

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным.

B.00001-01 32 01 (Руководство системного программиста) (пример - .pdf)

A.B.00001-01 32 01 (Руководство системного программиста) (шаблон - .doc)

• Лист утверждения
• Титульный лист
• Аннотация
• Содержание
• Основная часть
  • Общие сведения о программе
    • Назначение программы
    • Функции программы
    • Минимальный состав технических средств
    • Минимальный состав программных средств
    • Требования к персоналу (системному программисту)
  • Структура программы
    • Сведения о структуре программы
    • Сведения о составных частях программы
    • Сведения о связях между составными частями программы
    • Сведения о связях с другими программами
  • Настройка программы
    • Настройка на состав технических средств
    • Настройка на состав программных средств
  • Проверка программы
    • Описание способов проверки
    • Методы прогона
    • Контрольные примеры
    • Результаты
  • Дополнительные возможности (необязательны)
    • Описание дополнительных разделов функциональных возможностей программы
    • Способы выбора дополнительных возможностей
    • Сообщения системному программисту
• Приложения (необязательны)
• Регистрация изменений

Руководство системного программиста по ГОСТ -79

Составление информационной части (аннотации и содержания ) является обязательным [из п. 1.1 ГОСТ 19.503-79]

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

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

В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы» [из п. 1.2 ГОСТ 19.503-79]

В разделе «Общие сведения о программе» должна быть указаны назначение и функции программы и сведения о технических и программных средствах. обеспечивающих выполнение данной программы [из п. 2.1 ГОСТ 19.503-79]

В разделе «Структура программы» должны быть приведены сведения о структуре программы, ее составных частях. о связях между составными частями и о связях с другими программами [из п. 2.2 ГОСТ 19.503-79]

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

При необходимости приводят поясняющие примеры [из п. 2.3 ГОСТ 19.503-79]

В разделе «Проверка программы» должно быть приведено описание способов проверки. позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты) [из п. 2.4 ГОСТ 19.503-79]

В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора [из п. 2.5 ГОСТ 19.503-79]

В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений. выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям [из п. 2.6 ГОСТ 19.503-79]

В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из п. 2.7 ГОСТ 19.503-79]

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

United system for program documentation.
System programmer's guide. Requirements to contents and form of presentation

Постановлением Государственного комитета стандартов Совета Министров СССР от 12 января 1979 г. № 74 срок введения установлен

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста», определённого ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2094-80.

1.1. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

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

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

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

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

(Измененная редакция, Изм. № 1).

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

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

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

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

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

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

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

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

* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)