Если кроме использования и настройки, программное обеспечение предоставляет возможность написания, редактирования или использования программного кода. Какой документ необходим в этом случае?
Назначение руководства программиста
Руководство программиста относится к эксплуатационно-технической документации и требуется в тех случаях, когда система тем или иным образом предоставляет возможность написания, редактирования или использования программного кода.
Примерами могут служить:
– библиотека функций;
– платформа или среда для разработки ПО;
– ПО с открытым кодом.
Документ должен предоставлять всю необходимую информацию для того, чтобы разработчик мог воспользоваться возможностями системы. Для решения этой задачи содержание документа может включать в себя:
– назначение, структуру входных и выходных данных программных функций;
– возможности по созданию программного кода, особенности его интерпретации и компиляции;
– синтаксические особенности используемого языка программирования;
– возможные правила и ограничения при работе с программным кодом;
– различные инструкции по работе с программой.
Список возможных тем этим не ограничивается, все зависит от особенностей конкретной системы. Надо сказать, что руководство программиста бывает очень полезно и для разработчиков системы, являясь справочником по текущей реализации логики работы ПО.
Состав типового руководства программиста
В соответствии с требованиями ГОСТ руководство программиста должно содержать следующие разделы:
– Назначение и условия применения программы, где указывают область применения ПО и технические требования, необходимые для его работы.
– Характеристика программы, где описывают режим работы программы, показатели скорости ее работы и другие важные для использования характеристики.
– Обращение к программе, где указывают способы и параметры запуска программы;
– Входные и выходные данные, где описывают формат, способ организации и другие требования к входным и выходным данным;
– Сообщения, где приводят тексты сообщений, выдаваемых программой в различных ситуациях и действия, которые необходимо при этом предпринять.
Различные примеры, иллюстрации и таблицы целесообразно приводить в приложениях к документу.
Стандарты для руководства программиста
ГОСТы регламентируют и этот документ, в данном случае это ГОСТ 19.504. В соответствии с ним определяется структура и содержание Руководства программиста.
Стоимость разработки руководства программиста
|
Наименование документа |
Наименование стандарта |
Стоимость разработки |
|---|---|---|
|
Руководство программиста на ПО |
ГОСТ 19.504 |
100 тыс. р. |
Работа по созданию руководства программиста требует высокой квалификации специалиста и знаний в области программирования, однако, для профессиональных разработчиков такая работа обычно представляется скучной и нудной, к тому же, требует умения грамотно формулировать и доступно доносить материал. Специалисты ТехРайтКонсалт обладают большим опытом в обеих областях, что позволяет нам создавать документы по доступной цене и точно в срок!
Возможно, вас также заинтересует:
– разработка руководства администратора;
– создание руководства пользователя;
– разработка руководства оператора.
Разработка руководства программиста
Руководство программиста относится к эксплуатационно-технической документации. Разрабатывается такой документ для программных продуктов. Предназначен для ознакомления программистом, который будет решать те или иные задачи, связанные с эксплуатацией данной программы.
Когда требуется руководство программиста?
Руководство программиста необходимо в нескольких случаях:
Программа, на которую составляется документация, представляет собой среду разработки или библиотеку.
Данный программный продукт предоставляет платформу для написания типовых программ или систем.
Распространение продукта проходит совместно с программным кодом или же происходит его постоянная модификация разработчиком.
При помощи такого документа программисту должна быть представлена вся необходимая информация, которая может быть использована для создания собственных программных продуктов на базе данной системы. Информация должна быть предоставлена в достаточном количестве. Разработчики же при помощи руководства программиста имеют возможность зафиксировать текущее состояние выпускаемого продукта, чтобы избежать путаницы при выпуске новых продуктов.
К типичным задачам такого документа относится:
Уточнение и пояснение специалисту текущего состояния объектов, их местонахождения и методов взаимодействия. Также руководство программиста должно четко разграничить объекты, которые изначально внесены в систему, и объекты, которые программист создает самостоятельно.
Перечисление дополнительных средств разработки, которые потребуются при работе, кроме текущего продукта.
Уточнение требований к системе, программной среды, а также средств, необходимых для запуска.
Руководство программиста должно составляться грамотным профессионалом, знакомым со спецификой работы конкретного программного продукта и правилами составления подобных документов, регламентируемых по ГОСТ 19.504-79.
Структура документа
Требования к заполнению руководств программиста установлены соответствующим государственным стандартом. Структура такого документа должна включать в себя:
Предназначение и условия эксплуатации программного продукта.
Основные характеристики программы.
Методы обращения к программному продукту.
Основная входная и выходная информация.
Сообщения.
На данный момент руководство программистов включает также различные схемы — схемы баз данных, диаграммы классов, графы вызова функций.
Оформите заявку и задавайте все интересующие вас вопросы по телефону
+7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
Руководство — программист
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. Сообщения.
Составление
руководства системного программиста
— цель третьей части второй лабораторной
работы. Также руководство системного
программиста является пятым разделом
курсовой работы.
Требования
к оформлению руководства системного
программиста излагаются в ГОСТ 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.
Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #