Требования к оформлению документов гост: «ГОСТ Р 7.0.97-2016. Национальный стандарт Российской Федерации. Система стандартов по информации, библиотечному и издательскому делу. Организационно-распорядительная документация. Требования к оформлению документов» (утв. Приказом Росстандарта от 08.12.2016 N 2004-ст) (ред. от 14.05.2018)

Часто включает:

• Краткое изложение требований проекта
• Цели проекта
• Заявление о потребностях с подробным описанием почему проект необходим и как он будет удовлетворять эти потребности
• Финансовые отчеты, демонстрирующие, как будет финансироваться проект, и его влияние на баланс компании
• Функциональные требования и возможности
• SWOT-анализ бизнеса и того, как проект вписывается в него
• Потребности в персонале. Кем мы хотим работать над проектом?
• Расписание, график и сроки
• Анализ затрат и результатов

Обычно это одна страница с маркированным списком.

BRD обычно составляется руководителем проекта или бизнес-аналитиком.

2. Документ о функциональных требованиях (FRD)

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

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

Примером функционального требования может быть: « Когда пользователь нажимает кнопку OK, диалоговое окно закрывается, и пользователь возвращается к главному окну в том состоянии, в котором оно было до отображения диалогового окна.

В зависимости от сложности FRD могут иметь длину от 10 страниц до нескольких сотен

FRD обычно пишется бизнес-аналитиком или системным аналитиком

3. Документ рыночных требований (MRD)

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

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

Типовой PRD может содержать:

• Цели продукта
• Характеристики
• Процесс взаимодействия с пользователем (UX) и примечания к дизайну
• Требования к системе и среде
• Предположения, ограничения и зависимости — что ожидается, а также любые ограничения или препятствия, которые могут помешать прогрессу проекта

PRD обычно подготавливает менеджер по продукту.

5. Документ требований к пользовательскому интерфейсу (UIRD)

UIRD описывает внешний вид пользовательского интерфейса (UI) системы.

Часто определяет:

• Как содержимое представляется пользователю
• Пользовательская навигация
• Используемые цветовые коды
• Подсказки, подсказки и предложения для отображения
• Опции «Сохранить данные»
• Горячие клавиши

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

Это написано командой дизайнеров пользовательского интерфейса.

6. Документ технических требований (ТРД)

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

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

Хороший TRD должен включать следующие ключевые элементы:

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

Команда инженеров пишет TRD.

7. Документ с требованиями к качеству

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

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

Этот документ может быть написан руководителем проекта или бизнес-аналитиком

8. Документ требований к программному обеспечению или Спецификация требований к программному обеспечению (SRS)

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

SRS связана с FRD и PRD, но написана с учетом конкретного ИТ-проекта.

Может включать:

• Обзор продукта
• Обзор текущей системы
• Предлагаемые методы и процедуры
• Вопросы дизайна
• Вопросы безопасности

SRS обычно составляется ведущим инженером проекта.

9. Документ с требованиями клиента

Иногда его называют документом с требованиями клиента, и он может относиться к PRD, но для конкретного заказчика или клиента .

Автор:  Николас Рубрайт

Николас Рубрайт — специалист по цифровому маркетингу в QRA — компании, которая создает программное обеспечение, помогающее составлять документы с требованиями. Это достигается за счет автоматизированного языкового анализа и составления отчетов, которые помогают руководителям проектов, инженерам и бизнес-аналитикам снизить риски, связанные с написанием документов с требованиями.

Советы по документам с техническими требованиями

Зачем создавать документ с техническими требованиями?

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

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

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

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

Проблемы, возникающие из-за отсутствия документации по техническим требованиям, могут варьироваться от простых до сложных. «В одной компании, для которой я консультировал, — сказал Феллман, — жизненно важные вопросы соответствия FDA не решались, потому что человеческие ресурсы не смогли сделать что-то настолько простое, как возложить на себя обязанность заботиться о нормативных делах».

Руководство по управлению проектами

Универсальное решение для управления проектами

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

Просмотреть руководство

Ценность документов с техническими требованиями

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

• Определите свой бюджет.
• Создайте свой рабочий график.
• Разработать проект Диаграмма Ганта.
• Инициировать план связи.
• Определить аспекты управления рисками.

Ожидания составителей документа с техническими требованиями

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

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

Другие типы документов с требованиями, часто встречающиеся в бизнесе

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

Майкл Шриватсан (Michael Shrivathsan), вице-президент по управлению продуктами компании Acccompa, является экспертом по типам документов с требованиями и их функциям.

«Между документами по бизнесу, рынку и техническим требованиям может быть некоторое совпадение, — сказал Шриватсан. «В зависимости от организации они могут использовать или не использовать все эти типы документов. В крупных компаниях (более 1000 сотрудников) обычно используют все три документа. Большинство компаний среднего размера (200 сотрудников и более) используют как минимум два из них».

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

Документы о требованиях к бизнесу (BRD)
Написано: Менеджеры по продуктам, менеджеры по маркетингу продуктов
Аудитория: Бизнес -менеджеры
ОБЗОРЫ одобрено: руководителей высшего звена  

Документ бизнес-требований определяет высокоуровневое экономическое обоснование проекта и обычно готовится первым.

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

1. Характер потребностей ваших клиентов
2. Как удовлетворение этих потребностей согласуется с миссией вашей компании
3. Как ваш продукт, система или программное обеспечение будут решать потребности ваших клиентов на высоком уровне
4. Для обеспечения ясности рекомендуется портрет отношений между всеми заинтересованными сторонами в проекте с помощью соответствующих потоков, организационных схем или диаграмм.0016

 
Документ с требованиями рынка (MRD)
Автор: Менеджеры по продукции, менеджеры по маркетингу продукции
Аудитория: Бизнес-менеджеры  
Проверено и утверждено: Уровень директора
Документ с рыночными требованиями добавляет дополнительную информацию к BRD с точки зрения того, что нужно рынку, и точно определяет текущую рыночную среду для продуктов или программ, подобных той, которую вы разрабатываете. Знание того, что уже есть, как это продается и кому, может помочь вам определить пробелы в других функциях продукта.
 
Из документа с рыночными требованиями вы можете узнать следующую информацию, которая может помочь вам с документом с техническими требованиями: 

• Тип планируемого продукта
• Целевые клиенты
• персонажей, которые определяют:
  • Характеристики клиента
  • Проблемы, с которыми они сталкиваются
  • Как предлагаемый вами продукт поможет решить эти проблемы
• Конкурирующие продукты, их преимущества и недостатки
• способов сделать ваш продукт лучше

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

Технические требования должны быть сосредоточены на желаемых результатах

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

Шаблонный контрольный список технических требований — ценный организационный инструмент

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

• Функциональные требования и задачи, которые он будет выполнять
• Даты вождения с точки зрения вех
• Физические требования к материальному продукту, такие как размер, вес, цвет, форма, текстура и прочность
• Особенности технической среды
• Требования к данным
• Внешние интерфейсы
• Совместимость/портативность
• Техническое обслуживание

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

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

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

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

1. Определите ожидания и потребности конечного пользователя, а также то, как продукт будет использоваться в реальном мире. Задайте вопросы (вот несколько примеров):

• Какую основную проблему ваш продукт или программа решит для вашей аудитории?
• Чего вы хотите, чтобы люди выполняли, используя ваш продукт или программное обеспечение?
• Как сделать жизнь проще и продуктивнее?

2. Определите структуру команды и непредвиденные обстоятельства 

• Какие члены команды несут ответственность за аспекты работы? (Вспомните приведенный выше пример Феллмана и убедитесь, что все важные должностные обязанности распределены.)

3. Дайте определение продукту  

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

4. Создайте прототип, чтобы прояснить результаты, которые пользователи ожидают от нового продукта или системы после завершения

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

6. Убедитесь, что каждое системное требование описывает:

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

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

• Доступность — Сколько «время безотказной работы» вы можете ожидать от своей системы, исходя из ресурсов вашей системы, служб и доступности для конечных пользователей.
• Скрытая емкость — Как ваша система будет справляться с неожиданными пиками использования независимо от дополнительных ресурсов.
• Производительность — Учитывая конкретные условия нагрузки для ряда применений, каково будет время отклика и скрытая емкость.
• Масштабируемость — Насколько быстро можно увеличить или уменьшить емкость и количество пользователей без изменения исходной архитектуры.
• Удобство обслуживания — Насколько просто отслеживать, ремонтировать и обновлять как аппаратные, так и программные компоненты системы? Факторы, которые следует учитывать, включают планирование времени простоя, возможности обслуживания на основе моделей использования, критические моменты времени для доступности обслуживания, графики диагностики и мониторинга.
• Безопасность — Насколько безопасна система, включая авторизацию и аутентификацию пользователей и информации во время передачи?

Проверка и уточнение технических требований

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

Для Смита проверка требований была процессом привлечения к ним внимания как можно большего числа людей, выслушивания отзывов и обсуждения последствий сохранения или отклонения заданного требования. «На самом деле нет короткого пути. Все дело в привлечении ключевых заинтересованных сторон и работе с ними, чтобы понять и разрешить любые разногласия».

Смит предсказывает, что вы никогда не узнаете, выполнили ли вы все необходимые требования. «Возможно, вы соберете больше, чем вам нужно. Но как только они у вас появятся, определите их приоритетность и работайте над первоочередными требованиями, которые соответствуют вашему времени и бюджету. Иногда не самые большие требования являются самыми важными».

Держите заинтересованные стороны в курсе событий  

Сегодня существуют инструменты, которые позволяют заинтересованным сторонам напрямую наблюдать за процессом разработки, где они могут визуально отслеживать прогресс, просматривать (но не редактировать) требования по мере их реализации и тестировать ранние прототипы. «Разработка программного обеспечения — очень сложная вещь, — сказал Смит. «Люди восхищаются функциями еще до их разработки, и они могут быть очень разочарованы, если их ожидания не оправдаются». Поэтому информирование людей и предоставление им раннего доступа и регулярных обновлений любым удобным для них способом является ключом к удовлетворению конечных пользователей после выпуска продукта.

Подходит ли вам гибкое моделирование?

Agile Modeling (AM) — это еще один способ создания и документирования модели, которую можно использовать при разработке программных систем и продуктов. Его объем выходит за рамки документации по техническим требованиям, он включает весь процесс и сочетает передовой опыт, основанный на наиболее эффективных ценностях и принципах для создания наилучшего возможного программного обеспечения с учетом времени и бюджета.

Чтобы узнать больше об Agile Modeling, вот несколько рекомендуемых книг:

• Дисциплинированная гибкая доставка (DAD): Практическое руководство по гибкой доставке программного обеспечения на предприятии, Скотт В. Амблер и Марк Лайнс, IBM Press, ISBN: 013281013
• The Object Primer 3rd Edition: Agile Model Driven Development with UML 2. Cambridge University Press, 2004 ISBN#: 0-521-54018-6
• Введение в Disciplined Agile Delivery: A Small Team’s Journey from Scrum to Continuous Delivery Марк Лайнс и Скотт В. Амблер, Disciplined Agile Consortium, ISBN: 978 149 754 4383

Шаблоны технических требований в сравнении с программным обеспечением

Шаблоны просты в использовании и имеют приемлемую стоимость, но есть и альтернативы. Компания Шриватсана, Accompa, производит программное обеспечение для документирования требований, которое решает проблемы, которые могут возникнуть из-за избыточной или неверно истолкованной информации.

Это программное обеспечение:

• Отслеживает зависимости между этими тремя типами документов. Если что-то в документе бизнес-требований изменится, это может иметь каскадный эффект на рыночные и технические требования.
• Он предоставляет один репозиторий для хранения всей информации, чтобы ее можно было легко использовать (Шриватсан упомянул, что в большинстве крупных компаний эта информация может быть разбита на несколько блоков, что затрудняет ее поиск и использование).

«Для чего угодно, кроме самых маленьких проектов, почти невозможно отследить эти зависимости вручную, — сказал Шриватсан, — поэтому необходим доступный программный инструмент».

Рекомендации по написанию технических требований

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

1. Используйте простой и понятный язык, чтобы у всех было общее понимание того, что вы имеете в виду.
2. Будьте лаконичны. Начните с вводного абзаца, за которым следуют маркеры, чтобы улучшить читаемость.
3. Старайтесь, чтобы структура вашего предложения была простой, чтобы передать только одну основную мысль за раз.
4. Иногда изображение стоит 1000 слов, особенно если оно упрощает понятие или показывает связь одного понятия с другим.

Технические требования к образовательным учреждениям и предприятиям

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

Информация обычно включает:

• Минимальные конфигурации для платформ Windows и Mac, такие как минимальная скорость процессора или процессора, минимальный объем памяти и тип операционной системы.
• Скорость сетевого подключения для доступа в Интернет
• Текущий список поддерживаемых браузеров, а также ссылки для их загрузки
• Текущий список подключаемых модулей браузера, а также ссылки для их загрузки
• Информация о доступе в Интернет
• Как зарегистрировать учетную запись электронной почты школы или компании
• Необходимое программное обеспечение

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

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

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