Документирование программного обеспечения
В любом
случае наибольшее внимание должно уделяться самым важным для конечного
пользователя вопросам. Эти разделы являются основой документа и содержат
полное и окончательное описание всех свойств программного изделия.
3.3.n.2.1. Результаты. Описываются все выходные данные ПО с точки зрения их
функционального содержания и назначения (например, файлы, сообщения,
программно устанавливаемые сигналы и прерывания). При этом должны быть
рассмотрены все возможные в системе носители и средства отображения
информации. Указываются тип, структура, формат, объем, расположение и
диапазон изменения. Для всех выходных данных, читаемых людьми (сообщения и
отчеты) должны быть приведены образцы.
3.3.n.2.2. Процессы обработки. Описываются операции, выполняемые ПО в целом
или функциональными модулями, рассматриваемыми как черный ящик. Если
обсуждение идет на уровне модулей или этапов разработки, указываются также
модули или этапы, требуемые для получения определенной выходной информации.
Точно определяются все возможные ошибки, потенциальные условия их
возникновения и способы рестарта и восстановления. Подраздел должен
описывать инициацию, преобразование данных, все варианты завершения работы
(нормального и аварийного).
3.3.n.2.3. Входы. Описание подобно п. 3.3.2.1
3.3.n.3. Эргономические характеристики.
Примечание. Этот раздел описывает свойства, обеспечивающие надежность,
комфорт и продуктивность работы пользователей и операторов, а также вопросы
безопасности, секретности, восстанавливаемости после сбоев, мобильности ПО.
Остановимся более подробно на двух подразделах: Надежность и Рабочие
характеристики.
В разделе Надежность (это свойство программы понимается здесь как
способность к восстановлению нормальной работы при ошибках и сбоях в работе
оборудования) рассматриваются следующие вопросы:
защита данных пользователя;
степень защиты программ от ошибок, возникающих в других частях системы
(например, работающих одновременно с данной программой в другой области
памяти). Следует рассмотреть, как могут повлиять на работу предлагаемых
программных средств такие ошибки, учитывая следующие моменты: распределение
ресурсов памяти (указать, если предусмотрено обеспечение изоляции отводимых
областей памяти); связь программ через общие аппаратные ресурсы.
Раздел “Рабочие характеристики” описывает основные параметры или принципы,
по которым должна оцениваться эффективность работы программы, по
возможности в количественном виде с указанием возможных допусков. Все
параметры должны быть измеряемыми, к их числу могут относиться
быстродействие, пропускная способность, скорость передачи данных, расход
машинных ресурсов, время реакции (или задержки) и т.д.
3.3.n.4. Внутренние характеристики (этот раздел полностью расширяется в
документе “Внутренняя Спецификация”, однако частично может быть заполнен с
целью полного описания соответствующих внешних свойств).
3.4. Внутренние ограничения (здесь речь идет о тех свойствах, которые
пользователю логично ожидать, но которые по тем или иным причинам будут
исключены из программного изделия или потенциально оставлены на усмотрение
разработчика: например, неполная взаимозаменяемость носителей, отсутствие
поддержки каких-либо возможностей оборудования, и т.п.).
4. ИСПОЛЬЗУЕМЫЕ МАТЕРИАЛЫ (в т.ч. справочные)
5. ПЕРЕДАЧА ЗАКАЗЧИКУ И ВВОД В ДЕЙСТВИЕ
Руководство пользователя
Под документацией пользователя понимается документация, которая
обеспечивает конечного пользователя информацией по установке и эксплуатации
программного пакета. Под информацией на упаковке понимают информацию,
воспроизводимую на внешней упаковке программного пакета. Ее целью является
предоставление потенциальным покупателям первичных сведений о программном
пакете.
Пользовательская документация программного средства объясняет
пользователям, как они должны действовать, чтобы применить данную
программу. Она необходима, если программа предполагает какое-либо
взаимодействие с пользователями. К такой документации относятся документы,
которыми руководствуется пользователь при установке программы с
соответствующей настройкой на среду применения, при применении программы
для решения своих задач и при управлении программой (например, когда данное
программное средство взаимодействует с другими системами). Эти документы
частично затрагивают вопросы сопровождения программного средства, но не
касаются вопросов, связанных с модификацией программ.
В связи с этим следует различать две категории пользователей: ординарных
пользователей программы и администраторов. Ординарный пользователь
программы (end-user) использует программу для решения своих задач (в своей
предметной области). Это может быть инженер, проектирующий техническое
устройство, или кассир, продающий железнодорожные билеты с помощью данной
программы. Он может и не знать многих деталей работы компьютера или
принципов программирования. Администратор программны (system administrator)
управляет использованием программы ординарными пользователями и
осуществляет сопровождение программного средства, не связанное с
модификацией программ. Например, он может регулировать права доступа к
программе между ординарными пользователями, поддерживать связь с
поставщиками программы или выполнять определенные действия, чтобы
поддерживать программу в рабочем состоянии, если оно включено как часть в
другую систему.
Состав пользовательской документации зависит от аудиторий пользователей, на
которые оно ориентировано, и от режима использования документов. Под
аудиторией здесь понимается контингент пользователей, у которого есть
необходимость в определенной пользовательской документации. Удачный
пользовательский документ существенно зависит от точного определения
аудитории, для которой он предназначен. Пользовательская документация
должна содержать информацию, необходимую для каждой аудитории. Под режимом
использования документа понимается способ, определяющий, каким образом
используется этот документ. Обычно пользователю достаточно больших
программных систем требуются либо документы для изучения программного
средства (использование в виде инструкции), либо для уточнения некоторой
информации (использование в виде справочника).
Можно считать типичным следующий состав пользовательской документации для
достаточно больших программных средств:
Общее функциональное описание программного средства. Дает краткую
характеристику функциональных возможностей программного средства.
Предназначено для пользователей, которые должны решить, насколько
необходимо им данное программного средства.
Руководство по инсталяции программного средства. Предназначено для
системных администраторов. Он должен детально предписывать, как
устанавливать системы в конкретной среде. Он должен содержать описание
машинно-считываемого носителя, на котором поставляется программное
средство, файлы, представляющие программное средство, и требования к
минимальной конфигурации аппаратуры.
Инструкция по применению программного средства. Предназначена для
ординарных пользователей. Содержит необходимую информацию по применению
программного средства, организованную в форме удобной для ее изучения.
Справочник по применению программного средства. Предназначен для ординарных
пользователей. Содержит необходимую информацию по применению программного
средства, организованную в форме удобной для избирательного поиска
отдельных деталей.
Руководство по управлению программным средством. Предназначено для
системных администраторов. Оно должно описывать сообщения, генерируемые,
когда программные средства взаимодействует с другими системами, и как
реагировать на эти сообщения. Кроме того, если программное средство
использует системную аппаратуру, этот документ может объяснять, как
сопровождать эту аппаратуру.
Разработка пользовательской документации начинается сразу после создания
внешнего описания. Качество этой документации может существенно определять
успех программы. Она должна быть достаточно проста и удобна для
пользователя (в противном случае это программное средство, вообще, не
стоило создавать). Поэтому, хотя черновые варианты (наброски)
пользовательских документов создаются основными разработчиками программного
средства, к созданию их окончательных вариантов часто привлекаются
профессиональные технические писатели. Кроме того, для обеспечения качества
пользовательской документации разработан ряд стандартов, в которых
предписывается порядок разработки этой документации, формулируются
требования к каждому виду пользовательских документов и определяются их
структура и содержание.
Руководство программиста
Документация по сопровождению программного средства (system
documentation) описывает программное средство с точки зрения ее разработки.
Эта документация необходима, если программное средство предполагает
изучение того, как оно устроена (сконструирована), и модернизацию его
программ. Как уже отмечалось, сопровождение - это продолжающаяся
разработка. Поэтому в случае необходимости модернизации программного
средства к этой работе привлекается специальная команда разработчиков-
сопроводителей. Этой команде придется иметь дело с так
| |  скачать работу |
Документирование программного обеспечения |
