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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

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

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

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

Руководство программиста должно составляться грамотным профессионалом, знакомым со спецификой работы конкретного программного продукта и правилами составления подобных документов, регламентируемых по ГОСТ 19.504-79.

Структура документа

Требования к заполнению руководств программиста установлены соответствующим государственным стандартом. Структура такого документа должна включать в себя:
Предназначение и условия эксплуатации программного продукта.
Основные характеристики программы.
Методы обращения к программному продукту.
Основная входная и выходная информация.
Сообщения.

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

Оформите заявку и задавайте все интересующие вас вопросы по телефону
+7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.

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

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

2. Характеристики
   программы.

3. Обращение к
   программе.

4. Входные и выходные
   данные.

5. Сообщения.

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

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

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

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

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

Гост 19.505-79 еспд. Руководство оператора. Требования к содержанию и оформлению

Руководство
оператора должно включать:

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

2. Условия выполнения
   программы.

3. Выполнение
   программы.

4. Сообщения оператору.

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

Условия выполнения
программы должны
содержать условия, необходимые для
выполнения программы: минимальный и/или
максимальный состав аппаратурных и
программных средств.

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

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

Гост 19.506-79 еспд. Описание языка. Требования к содержанию и оформлению

При описании языка
необходимо указать:

1. Общие сведения.

2. Элементы языка.

Кроме того,
допускается вводить дополнительные
разделы.

1. Способы
   структурирования программы.

2. Средства обмена
   данными.

3. Встроенные
   элементы.

4. Средства отладки
   программы.

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

В разделе Элементы
языка приводят
описание синтаксиса и семантики базовых
и составных элементов языка.

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

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

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

При
описании средств
отладки необходимо
привести
описание имеющихся в языке средств
отладки программ, семантики этих средств,
дать рекомендации по их применению.

ГОСТ
Р ИСО/МЭК 9294-93. Информационная технология.
Руководство
по управлению документированием
программного обеспечения.
Стандарт
полностью соответствует международному
стандарту ИСО/МЭК 9294:1990 и устанавливает
рекомендации по эффективному управлению
документированием ПС для руководителей,
отвечающих за их создание. Целью стандарта
является оказание помощи в определении
стратегии документирования ПС; выборе
стандартов по документированию; выборе
процедур документирования; определении
необходимых ресурсов; составлении
планов документирования.

ГОСТ
Р ИСО/МЭК 9126-93. Информационная технология.
Оценка
программной продукции. Характеристики
качества и руководства
по их применению. Стандарт
полностью соответствует международному
стандарту ИСО/МЭК 9126:1991. В его контексте
под характеристикой качества понимается
«набор свойств (атрибутов) программной
продукции, по которым ее качество
описывается и оценивается». Стандарт
определяет шесть комплексных
характеристик, которые с минимальным
дублированием описывают
качество ПС (ПО, программной продукции):

• функциональные
  возможности;

• надежность;

• практичность;

• эффективность;

• сопровождаемость;

• мобильность.

Эти характеристики
образуют основу для дальнейшего уточнения
и описания качества ПС.

ГОСТ
Р ИСО 9127-94. Системы обработки информации.
Документация
пользователя и информация на упаковке
для потребительских
программных пакетов. Стандарт
полностью соответствует
международному стандарту ИСО 9127:1989. В
контексте настоящего стандарта под
потребительским программным пакетом
(ПП) понимается «программная продукция,
спроектированная и продаваемая для
выполнения определенных функций;
программа и соответствующая ей
документация, упакованные для продажи
как единое целое». Под документацией
пользователя понимается документация,
которая обеспечивает конечного
пользователя информацией по установке
и эксплуатации ПП. Под информацией на
упаковке понимают информацию,
воспроизводимую на внешней
упаковке ПП. Ее целью является
предоставление потенциальным
покупателям первичных сведений о ПП.

ГОСТ
Р ИСО/МЭК 8631-94. Информационная технология.
Программные
конструктивы и условные обозначения
для их представления.
Описывает
представление процедурных алгоритмов.

Как
уже говорилось, пока нет лучшего, можно
извлекать пользу и
из тех стандартов ЕСПД, которые приняты
еще около 20 лет назад. Но всем ясно, что
ориентироваться надо на современные
стандарты.

Практики используют
еще один путь: сами переводят и используют
в своих проектах современные стандарты
на организацию ЖЦ ПС и их документирование.
Но этот путь страдает как минимум
тем недостатком, что разные переводы и
адаптации стандартов,
сделанные разными разработчиками и
заказчиками, будут отличаться массой
деталей. Эти отличия неизбежно касаются
не только наименований, но и их
содержательных определений, вводимых
и используемых в стандартах. Таким
образом, на этом пути неизбежно постоянное
возникновение путаницы, а это прямо
противоположно целям не только стандартов,
но и любых грамотных методических
документов [59].

ГОСТ
Р ИСО/МЭК 12119:1994. Информационная технология.
Пакеты
программных средств. Требования к
качеству
и испытания. В
этом стандарте установлены требования
к качеству пакетов программ и инструкции
по их испытаниям
на соответствие заданным требованиям.
Понятие «пакет программных средств»
фактически отождествляется
с более общим понятием «программный
продукт», рассматриваемым
как совокупность программ, процедур и
правил, поставляемых
нескольким пользователям для общего
применения или
функционирования. Каждый пакет программ
должен иметь описание
продукта и пользовательскую документацию.

Рассмотрим более
подробно содержание данного стандарта.

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

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

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

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

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

• требования к
  документации пользователя;

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

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

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

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

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

1. Общие требования
   к содержанию.

2. Обозначения и
   указания.

3. Функциональные
   возможности.

4. Надежность.

5. Практичность.

6. Эффективность.

7. Сопровождаемость
   и мобильность.

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

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

• быть внутренне
  непротиворечивым. Каждый термин должен
  иметь один и тот же смысл по всему
  документу;

• формулировки
  должны быть проверяемыми и корректными.

При описании
продукта необходимо приводить следующие
указания
и
обозначения:

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

1. Должны быть
   включены наименование и адрес поставщика.

1. Должны быть
   определены целевые рабочие задачи,
   которые могут быть выполнены данным
   продуктом.

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

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

• процессоры, включая
  сопроцессоры;

• объем основной
  (оперативной) памяти;

• типы и объемы
  (памяти) периферийных запоминающих
  устройств;

• расширяющие платы;

• оборудование
  ввода и вывода;

• сетевое оборудование;

• системные и прочие
  программные средства.

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

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

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

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

5. Должно быть
   указано, будет или не будет предлагаться
   поддержка при эксплуатации продукта.

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

При описании
функциональных
возможностей необходимо
отразить:

1.
Обзор
функций.

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

• продукта;

• расширения
  продукта, полностью приведенного в
  описании продукта;

• расширения
  продукта, на которое дана ссылка в
  описании продукта;

• негарантируемого
  (необязательного) приложения.

2. Граничные
значения.

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

• минимальные или
  максимальные значения;

• длины ключей;

• максимальное
  число записей в файле;

• максимальное
  число критериев поиска;

• минимальный объем
  выборки.

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

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

Cтраница 1

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

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

Руководство программиста 13 175 — 83 Автоматизированные системы управления.
 [3]

В Руководство программиста для программы-компонента включаются сведения о способах приема и передачи параметров, обращения к программе, используемой базе данных, версии операционной системы, программах ОПО АСУТП и вычислительных ресурсах.
 [4]

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

В руководстве программиста и руководстве оператора должны содержаться сведения о принципах работы программы и подробные инструкции по ее эксплуатации. В руководстве программиста должна быть приведена полная информация о всех возможных вариантах работы программы. Это необходимо для эффективной эксплуатации разработанных программных средств. Руководство оператора должно включать подробные инструкции по эксплуатации программы и взаимодействию с ней обслуживающего персонала.
 [6]

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

В программную документацию рабочего проекта входят: руководство программиста; руководство оператора; эксплуатационная программа или текст программы; описание контрольного примера.
 [8]

Знакомство со стандартными языками позволяет им под руководством программиста, объединившись в творческие бригады, уже в 4 — 5 — м классе участвовать в разработке общественно-полезных программ. Так, например, было создано программное обеспечение подготовки перфолент для программно-управляемых вышивальных аппаратов, информационно-справочная система по белковым соединениям и другая — для книгообмена.
 [9]

Особо подчеркнем, что прежде чем пользоваться директивами, необходимо тщательно ознакомиться с соответствующим руководством программиста.
 [10]

Исходя из этого, удобно разделить всю документацию по программе на описание применения, руководство оператора, руководство программиста и руководство системного программиста.
 [11]

Все граничные значения параметров, используемых в программа, методы подготовки программ и режимы работы машины описаны в Руководстве программиста для каждого конкретного типа ЭВМ.
 [12]

Специфика такой работы, форматы сообщений в каналах связи, схемы подключения машин и требования к программам подробно рассматриваются в Руководстве программиста для каждого типа ЭВМ.
 [13]

При проектировании пакета прикладных программ должны быть построены документы: 1) пояснительная записка; 2) общее описание; 3) руководство программиста; 4) описание языка; 5) описание программ; 6) порядок и методика испытаний.
 [14]

В руководстве программиста и руководстве оператора должны содержаться сведения о принципах работы программы и подробные инструкции по ее эксплуатации. В руководстве программиста должна быть приведена полная информация о всех возможных вариантах работы программы. Это необходимо для эффективной эксплуатации разработанных программных средств. Руководство оператора должно включать подробные инструкции по эксплуатации программы и взаимодействию с ней обслуживающего персонала.
 [15]

Страницы:  

   1

   2

---

Общая информация

Документация принадлежит к типу программной и эксплуатационной. Объединяет в себе пакеты документов программы, комплекса и его программных компонентов. Создается для программистов-создателей программы и тех программистов, работающих с данным программным продуктом или разрабатывающих новые продукты на базе данного. 
Целью документации является предоставление программистам возможностей для решения задач, поставленных для данной программы. Все документы соответствуют стандартам: ГОСТ 19.504-79.

Предмет и применение

Руководство для программистов разрабатывается если:
1. Создаваемая программа предназначена для области разработки или библиотеки.
2. Создаваемая программа становится основой для разработки программ и систем конкретного вида.
3. Распространение программного продукта происходит вместе с исходным кодом или она нуждается в постоянной модификации.
Бывают и другие случаи, требующие разработки руководства для программиста, но они являются единичными.
Основной целью руководства является обеспечение программиста-разработчика сведениями для написания собственной программы на базе данной.

Содержание

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

Методология и язык написания

Главное — логичность и порядок изложения. Необходимо, чтобы текст соответствовал следующим правилам:
— Появление нового определения должно базироваться на уже известных ранее;
— Появление всех понятий должно быть целесообразным и обоснованным.
При описании отдельных объектов главное внимание уделяется:
— описание всего, что происходит до создания и применения объекта;
— способы восприятия объектом поступаемых сведений;
— местоположение объекта.
Описание всех объектов чаще всего объединяют в «Справочник программиста».

Стандартная структура — согласно ГОСТ 19.504-79.

1. Назначение и условия применения программы.
2. Характеристика программы.
3. Обращение к программе.
4. Входные и выходные данные.
5. Сообщения.