Как составить руководство программиста

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

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

5.1 Гост 19.503-79

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

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

5.1.1 Общие положения

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

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

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

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

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

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

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

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

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

5.1.2 Содержание разделов

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

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

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

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

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

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

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

5.2 Пример

5.2.1 Общие сведения о программе

Программа
«Автоматизированное рабочее место
читателя» предназначена для обеспечения
простого и удобного доступа удаленных
пользователей к ресурсам различных
информационных служб. Удаленными
пользователями могут являться любые
пользователи HTTP-сервера, на базе
которого функционирует программа.
Ресурсами информационных служб могут
являться различные удаленные базы
данных (библиографические, полнотекстовые,
базы данных запросов на доставку
документов, тезаурусы), доступные по
протоколу ISO 23950. Таким образом, программа
является промежуточным звеном многозвенной
информационной системы, обеспечивающим
пользователей следующими возможностями:

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

• заказ
  документа (копии) по найденному
  библиографическому описанию;

• проверка
  статуса заказа;

• вывод
  списка документов, полученных во
  временное пользование.

Другими
словами, программа является Z39.50-клиентом
с Web-интерфейсом пользователя. Поэтому
для работы с программой пользователю
необходимы
лишь Web-агент (Netscape
Navigator,
MS
Internet
Explorer,
Lynx
и т.п.) и надежная связь с HTTP-сервером,
на котором выполняется программа.

Программа
может функционировать на любых технических
средствах под управлением любой
операционной системы, отвечающей
стандарту ISO/IEC
9945-1 (POSIX)
и спецификациям X/Open
CAE
specifications,
Issue
4, July
1992 (XPG4).
Обязательными требованиями для выполнения
программы являются поддержка стека
протоколов TCP/IP и наличие HTTP-сервера,
поддерживающего CGI.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #

Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).

«Шифрование
данных»

Программа

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

643.02069436.41NNN–01
33 01-1

Листов 6

---

АННОТАЦИЯ

Приводится руководство
программиста программы «Шифрование
данных».

Программа предназначена
для шифрования и дешифрования данных,
с применением алгоритма шифрования
«Шифр-Гост 28147-89».

Ограничения программы: программа
аварийно завершается при загрузке
файлов с размером более 500 МБ.

Условия эксплуатации программы:

возможность применения в локальной
сети;

на персональных компьютерах
с процессором не ниже 300МГц, минимум
оперативной памяти 16 MБ и операционная
система не ниже Windows 95.

Распространяется на дискетах.

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

---

СОДЕРЖАНИЕ

стр.

---

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

1.1 Назначение программы

Описываемая программа предназначена
для шифрования и дешифрования
данных, хранящихся в файлах.

1.2 Функции программы

• Функция
  открытия и чтения файла “LoadFile”
  вызывается путем нажатия
  Файл->Открыть и
  загрузка данных из файла при выборе
  файла в диалоговом окне.
  

• При нажатии Шифрование->Зашифровать
  программа вызывает процедуру “Coding”,
  которая зашифровывает данные и выводит
  результат в окно для ввода текста.

• При выборе в меню
  Шифрование->Расшифровать
  – программа вызывает процедуру
  “Recoding”,
  которая расшифровывает данные с выводом
  в результата в текстовое окно.

• Запись данных в файл
  происходит путем нажатия Файл->Сохранить
  – вызове функции
  “SaveFile”и
  выборе в диалоговом окне документа для
  записи данных.

1.3 Использование оперативной памяти

Количество необходимой оперативной
памяти определяется размером обрабатываемых
данных, плюс к этому 1 МБ для загрузки
самой программы и создания всех
необходимых переменных и структур.

1.4 Требования к программному обеспечению

Операционная система Windows95
и выше.

2.1 Средства проверки правильности
выполнения программы

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

2.2 Функционирование программы после
сбоев

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

3.1 Способы вызова программы с различных
носителей данных

Программа может вызываться с любых
носителей.

3.2 Входные точки в программу

Исполняемым файлом программы является
файл “CodingGost.exe“.

3.3 Способы передачи управления и
параметров данных

Передача параметров производится в
режиме диалога программы с пользователем.

3.4 Обращение к программе – приложению

С помощью программ файл – менеджеров
зайти в каталог, в который установлена
программа и запустить файл “CodingGost.exe”.

4.1 Формат, характер и организация входных
данных

Загрузка данных в виде текста или файла
любого формата для (рас)зашифровывания.

4.2 Формат, характер и организация выходных
данных

Cохранение (рас)зашифрованных
данных в файл любого формата, либо
простым отражением в текстовом поле.

5.1 Сообщения программисту и действия
по ним

№ п/п	Сообщение	Описание	Действия
1	2	3	4
1.	“Отсутствуют данные для обработки!”	Системное окно сообщения с информацией, о том, что файл не открыт.	Загрузить файл.
2.	“Не задан ключ!”	Системное окно сообщения с информацией, о том, что ключ не задан.	Ввести ключ для шифрования в соответствующее поле.

---

6.1 Примеры

Производится
открытие файлов путем
нажатия Файл->Открыть и
загрузка данных из файла при выборе
файла в диалоговом окне.

Возможен ввод текста для шифрования в
окно и его загрузка из него.

При нажатии Шифрование->Зашифровать
программа зашифровывает данные и выводит
результат в окно для ввода текста.

При выборе в меню Шифрование->Расшифровать
– происходит расшифровка данных с
выводом в результата в текстовое окно.

Запись данных в файл происходит путем
нажатия Файл->Сохранить и выборе
в диалоговом окне документа для записи
данных.

Можно изменить параметры шифрования –
ключ шифрования, “S
– блоки”.

6.2 Иллюстрации

Основная форма

Окно ввода
(отображения) Ключ Окно
вывода (отображения)

Главное меню
Строка состояния
процесса

---

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

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

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

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

– библиотека функций;

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

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

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

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

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

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

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

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

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

Состав типового руководства программиста

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

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

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

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

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

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

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

Стандарты для руководства программиста

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

Стоимость разработки руководства программиста

Наименование документа	Наименование стандарта	Стоимость разработки
Руководство программиста на ПО	ГОСТ 19.504	от 100 тыс. р.

Работа по созданию руководства программиста требует высокой квалификации специалиста и знаний в области программирования, однако, для профессиональных разработчиков такая работа обычно представляется скучной и нудной, к тому же, требует умения грамотно формулировать и доступно доносить материал. Специалисты ТехРайтКонсалт обладают большим опытом в обеих областях, что позволяет нам создавать документы по доступной цене и точно в срок!

Возможно, вас также заинтересует:

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

---