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

Документ технических требований (ERD) — это заявление, описывающее цель и назначение нового компонента. В отличие от документа с требованиями к продукту (PRD), который сообщает инженерам, что им нужно построить, ERD указывает, почему создается деталь и как ее дизайн способствует достижению цели. Следуя инженерным требованиям, изложенным в ERD, инженеры могут гарантировать, что создаваемая ими деталь будет удовлетворять потребности клиентов. Использование ERD также помогает оптимизировать производство различными способами:

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

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

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

Для начала все действующие документы с техническими требованиями имеют следующие шесть общих элементов:

Ясность

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

Необходимость

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

Координация

Технические требования должны быть правильными на протяжении всей конструкции изделия. ERD должен описывать все требования к продукту, цели, условия и возможности. По возможности объясняйте, что делает продукт, в числовой форме для максимальной точности.

Тестируемость

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

Осуществимость

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

Отслеживаемость

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

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

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

Использовать шаблон технических требований

Вы можете сэкономить время и энергию в начале нового проекта, используя шаблон документа с техническими требованиями. Шаблон ERD гарантирует, что ваш ERD всегда правильно структурирован. Как минимум, шаблон документа с техническими требованиями должен иметь титульную страницу, заголовки разделов и другие стандартизированные разделы, известные как «шаблоны». Используйте шаблоны, чтобы охватить темы ERD, такие как использование глаголов, сокращения, ключевые слова, стандарты форматирования и другие рекомендации, необходимые для понимания вашего ERD.

Избегайте написания операций и реализаций

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

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

Оцените свой ERD

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

Используйте правильный язык

Есть несколько языковых правил, которым вы всегда должны следовать при написании документа с техническими требованиями. Три больших термина, характерных для ERD, — это должен, будет и должен. «Должен» представляет требования, «будет» представляет факты, а «следует» представляет цели.

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

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

• Но не только и т. д. — Эти условия охватывают неизвестное, и в вашем ERD не должно быть ничего неизвестного или непредсказуемого.
• И/или — Это оставляет слишком много вариантов интерпретации и возможность ошибки, потому что подрядчик будет прав в двух разных сценариях (если он выберет И или если он выберет ИЛИ).
• Слабые слова которые не имеют количественного значения. Сюда входят такие прилагательные, как «мощный» и «эффективный», а также такие глаголы, как «улучшать» или «усиливать». Кроме того, старайтесь избегать сравнений (например, быстро или медленно, больше или меньше) и других неколичественных выражений.

При написании ERD вы также должны избегать отрицательных утверждений и сосредоточиться на существовании элемента или возможности требования. Единственный случай, когда допустимо использовать отрицательные характеристики, — это подчеркивание потенциально опасной ситуации. Даже в этих случаях не забудьте также указать меры безопасности.

Не будьте слишком конкретными

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

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

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

Для получения дополнительных ресурсов по разработке продуктов посетите учебный центр Fast Radius.

Готовы создавать детали с помощью Fast Radius?

Начать цитату