Программные продукты
Программные продукты и документация на них
Понятие
программного продукта
Под программным
продуктом понимается программа, которую независимо от ее разработчиков
можно использовать в предусмотренных целях на разных компьютерах, если только
они удовлетворяют ее системным требованиям. Разумеется, сформулированное
сейчас определение верно не только для отдельной программы, но и для
программного комплекса. При этом, когда мы говорим о возможности
использования, то имеем в виду сразу несколько обстоятельств:
- Программа в состоянии нормально функционировать не только на
компьютере у автора, а в рамках любой подходящей системы.
- Автор (или иной правообладатель) на определенных условиях позволяет
распространять и использовать программу.
- Человек, получивший в распоряжение дистрибутив программы, сможет
самостоятельно установить и полноценно применять ее.
Последний пункт имеет непосредственное отношение к технической
документации.
Типы технической документации на программный
продукт
Всю документацию на программный продукт можно разделить на
следующие категории:
-
Документация управления проектом -
организационные документы, которыми обмениваются между собой те, кто так
или иначе участвует создании программы.
-
Документация разработки - технические
документы, которыми обмениваются между собой те, кто так или иначе
участвует создании программы.
-
Документация продукции - технические
документы, которые предоставляются потребителю в комплекте поставки
программы или отдельно от нее.
В составе документации продукции можно выделить эксплуатационную документацию, т. е. такую, которая
используется при эксплуатации системы. В свою очередь, в составе
эксплуатационной документации можно выделить документацию пользователя, адресованную лицам,
непосредственно работающим с программой.
Состав технической
документации на программный продукт
Документация разработки
программного продукта
Состав документации разработки программного
продукта в значительной мере зависит от методологии, которую исповедует
коллектив разработчиков. Каждая методология, скажем, RUP или MSF,
предусматривает свой набор документов. Идеологически эти наборы во многом
похожи, хотя одни и те же документы в них могут по-разному называться и иметь
разную структуру.
В Единой
системе программной документации понятие документации разработки
отсутствует, но как таковая она там предусмотрена. В табл. 1 приведен состав
документации разработки согласно ЕСПД.
Таблица 1.
Документация разработки программы согласно ЕСПД
| Документ |
Источник |
Аудитория |
Содержание |
| техническое задание |
аналитик |
проектировщик ПО |
требования к программе |
| пояснительная записка к техническому проекту |
проектировщик ПО |
программист |
устройство программы |
| программа и методика испытаний |
аналитик |
представитель заказчика, осуществляющий приемку программы |
процедуры, позволяющие убедиться в соответствии программы
техническому заданию |
Эксплуатационная документация на программный
продукт
Состав комплекта эксплуатационной документации на программный
продукт зависит от архитектуры последнего, назначения его компонентов и
особенностей пользовательской аудитории.
Наиболее распространенные типы
эксплуатационных документов приведены в табл. 2.
Таблица 2. Эксплуатационная документация на программный
продукт
| Документ |
Аудитория |
Примерное содержание |
| описание
программы |
лица, принимающие решения о приобретении, вводе в
эксплуатацию и способах использования программы |
назначение и основные возможности программы, необходимые
ей нее системные ресурсы, входные и выходные данные |
| описание
применения |
| описание
языка |
пользователи языка (программисты, операторы, кодеры,
верстальщики) |
основная идея языка, его синтаксис, элементы и конструкции,
встроенные функции |
| паспорт |
лица, ответственные за эксплуатацию программы |
краткие сведения о программе и условиях ее поставки |
| руководство администратора |
ответственный пользователь системы, обеспечивающий ее целевое
применение |
управление учетными записями пользователей, назначение пользователям
прав доступа, ведение нормативно-справочной информации, загрузка и
выгрузка данных |
| руководство оператора |
операторы, работающие с системой, частью которой является
программа |
порядок выполнения предусмотренных операций, сообщения программы и
предписанные оператору способы реакции на них |
| руководство пользователя |
пользователи программы, т.е. лица, применяющие ее для решения
собственных прикладных задач |
назначение и возможности программы, ее основные концепции, интерфейс
пользователя, порядок решения типовых задач, описание функций
программы |
| руководство программиста |
программисты, сопровождающие программу или использующие ее в
качестве платформы либо средства разработки при создании собственных
программ |
архитектура программы или создаваемых на ее основе приложений,
описание программных интерфейсов к ее объектам, протоколов обмена
данными и т. п. |
| руководство системного администратора
(системного программиста) |
системные администраторы, осуществляющие установку программы и
поддерживающие систему в рабочем состоянии |
установка программы, ее интеграция в систему, проверка правильности
функционирования, устранение аварийных ситуаций |
| спецификация |
лица, ответственные за эксплуатацию программы |
комплект поставки программы |
| справочная
система ('хелп') |
пользователи, операторы, администраторы, системные администраторы,
программисты и др. |
материал всех имеющихся руководств и описаний, краткие описания
элементов интерфейса пользователя программы |
| формуляр |
лица, ответственные за эксплуатацию программы |
краткие сведения о программе и условиях ее поставки, записи
эксплуатационного о возникающих сбоях и прочих событиях такого рода |
