Разработка программного обеспечения и систем (стр. 6 )

B.3 Пример документации

B.3.1 Краткий обзор

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

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

Tiny Ltd - небольшая компания, которая производит современное аналитическое оборудование для сельского хозяйства. Некоторые из их продуктов имеют решающее значение в том смысле, что неправильные результаты анализа могут привести к неправильным дозам удобрения (слишком большого или слишком большого) для применения к культурам. Таким образом, организация должна производить оборудование в соответствии с конкретным стандартом, в котором указаны требования, касающиеся производства и обеспечения качества определенных документов и прослеживаемости между элементами рабочего продукта.

В этом примере проект представляет собой техническую спецификацию продукта под названием UV / TIT-14 33a. Это устройство для измерения элементов удобрений и их концентрации в образцах грунта. Аппарат имеет пользовательский интерфейс, работающий на ПК с беспроводным подключением к измерительной системе.

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

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

Примеры не обязательно завершены. Там, где пункты были опущены, это отмечено тремя вертикальными точками, например:

· · ·

Опущенный текст идентифицируется с помощью многоточия, как этот «...».

B.3.2 Пример журнала проблем - Big Corporation

Рисунок B.2 является примером журнала проблем, который используется в Big Corporation. Здесь вопросы просто выделяются в дизайне пользовательского интерфейса.

Рисунок B.2 - Пример журнала ошибок для Big Corporation

B.3.3 Пример журнала ошибок - Tiny Ltd

Таблица B.1 является примером журнала ошибок, используемого в Tiny Ltd. Это журнал проблем, созданный отдельным рецензентом (Jean Kettles) в рамках «Индивидуального обзора» Спецификации требований к системе. Поля для «Статус» и «Назначено» будут заполнены, когда вопросы будут проанализированы в ходе операции «Сообщение о связи и анализ» (см. 6.4.4).

Таблица B.1 - Пример журнала проблем для Tiny Ltd

Протокол ошибки
Технический обзор спецификации системных требований для UV / TIT-14 33a v1.0
Проблемы, обнаруженные	Jean Kettles	Дата	14 th Mar  2015
ID	Описание	Критичнсть	Положение дел	Назначено
1	Указанное максимальное количество элементов, которые могут быть найдены, не может быть обработано указанным алгоритмом концентрации
H	TBD	TBD
2	Результаты алгоритма концентрации должны отображаться только в одну десятичную точку - для спецификации пользователя требуется 3 десятичных точки.
L	TBD	TBD
3	История пересмотра документа неполна	L	TBD	TBD
4	Системная спецификация не выполняет требования к конфигурации (3.4.5.12) в соответствии с требованиями пользователя.
H	TBD	TBD
…

B.3.4 Пример отчета об инциденте - Крупная корпорация

Таблица B.2 является примером отчета об инциденте, используемого в Big Corporation. Отчеты об инцидентах обычно создаются только в тех случаях, когда проблема не может быть решена гибкой командой в рамках текущей итерации или когда она применяется к продукту или документу, внешнему по отношению к гибкой команде.

Таблица B.2 - Пример отчета об инциденте для крупной корпорации

Форма регистрации инцидента
Число	Итерация 10 - Команда QQQ # 31
Короткое название	Протокол оплаты отсутствует лидирующий идентификатор
Продукт/ Документ	Определение протокола сетевой плате ACME (внешний - ACME Payments Ltd)
Статус = Открыть
Регистрация создана	Майк Нельсон	Дата	1 /11/ 15
Критичность	Высокая	Приоритет	Низкий
Полное описание	В определении протокола для платежных сообщений не указывается, что всем входящим платежным сообщениям должно предшествовать %% INC %%, когда по умолчанию для исходящего сообщения об оплате.
Контекст	Неофициальный обзор группы - члены команды QQQ 1/11/15

B.3.5 Пример отчета о происшествии - Tiny Ltd

Таблица B.3 является примером отчета об инциденте, используемого в Tiny Ltd.

Таблица B.3 - Пример отчета о происшествии для Tiny Ltd

Отчет об инциденте
Номер	Tiny_Review_00233
Короткое название	Полевые испытания Продолжительность Слишком короткое поле
Рабочий продукт	Спецификация требований пользователя для UV / TIT-14 33a
Версия (n. m)	1.0
Статус = Открыть
Отчет создан	Amir Khan	Дата и время	14th Mar 11.30 am
Проблема, отмеченная	Amir Khan	Дата и время	17th Mar 11.00 am
Полное описание	Требование пользователя указывает, что входное текстовое поле для продолжительности полевого испытания должно быть ограничено 5 символами, но полевые испытания могут превышать 99 часов, и поэтому требуется 6 символов.
Наблюдается во время	Прогулка/обзор/проверка/код и сборка/тестирование/использование
Наблюдается в	Требование / Дизайн / Реализация / Тестирование / Эксплуатация
Симптом	Операционный системный сбой/зависание программы/сбой программы /ввод/вывод/общий сбой продукта/системная ошибка/прочее: Требование пользователя указывает неправильную длину поля - поскольку это является основой для контракта и запланированных платежей, которые он должен признать и исправить клиентом.
Влияние пользователя	Высокий /Средний / Низкий
Пользовательская срочность	Urgent / High / Medium / Low / None Срочно / Высокий / Средний / Низкий / Нет

B.3.6 Отчет по обзору примеров – Большая корпорация

Таблица B.4 представляет собой обзорный отчет неофициального группового обзора, проведенный на экране нового образца регистрации прототипа.

Таблица B.4 - Пример отчета о пересмотре для Big Corporation

• Описание рабочего продукта: экран регистрации нового пользователя • Участники: три опытных рецензента, которые раньше работали над аналогичными проектами. • Резюме результатов обзора. Было обнаружено 7 проблем, которые были обнаружены рецензентами (как видно на отсканированной отмеченной копии прототипа...). • Оценка рабочего продукта: рекомендация по решению всех 7 вопросов была предоставлена команде разработчиков пользовательского интерфейса.

ПРИМЕЧАНИЕ. Эта информация может быть представлена во многих различных форматах, например. электронной почте или устно.

B.3.7 Обзор отчета о примерах - Tiny Ltd

Таблица B.5 представляет собой обзорный отчет для технического обзора спецификации технических требований V 0.9 (для УФ / ТИТ-14 33а).

Таблица B.5 - Пример отчета о пересмотре для Tiny Ltd

Обзор отчета - Технический обзор - Sys Reqts Specn V 0.9

Дата отчета: 22 марта 2015 г.

Пересмотренный документ: Спецификация технических требований V 0,9 для УФ / ТИТ-14 33a

Исходный документ: спецификация требований пользователей v 2.3 для серии UV / TIT-14 33

Участники: Лидер обзора и координатор: Фрэнк Спенсер, автор и писатель: Бетти Фишер, технический руководитель:

Том Джонс, Рецензенты: Глин Льюис и Ронни Мудрость.

Обзор показателей:

Рецензенты сообщили, что они провели в среднем 4,7 часа при индивидуальной подготовке к обзору. Совещание по обзору (с участием всех участников) продолжалось 110 мин.