Comment rédiger un document d'exigences techniques

Un document d'exigences techniques (ERD) est une déclaration décrivant l'objectif et le but d'un nouveau composant. Contrairement à un document d'exigences de produit (PRD), qui indique aux ingénieurs ce qu'ils doivent construire, un ERD spécifie pourquoi une pièce est en cours de construction et comment sa conception alimente son objectif. En suivant les exigences d'ingénierie décrites dans un ERD, les ingénieurs peuvent s'assurer que la pièce qu'ils construisent répondra aux besoins des clients. L'utilisation d'un ERD permet également de rationaliser la production de différentes manières :

• Les ERD utilisent une communication définie et cohérente pour promouvoir la collaboration, réduire les erreurs de communication et garder tout le monde sur la même longueur d'onde.
• Les ERD aident à décomposer les grands projets en tâches plus petites, ce qui les rend plus faciles à déléguer ou à externaliser.
• Les ERD peuvent être vérifiés par rapport aux PRD pour s'assurer que toutes les intentions de conception sont correctement mises en œuvre et que tous les objectifs du produit sont atteints.

Un ERD bien rédigé permet aux ingénieurs et aux fabricants de répondre à des questions critiques sur la conception et l'objectif des pièces sans avoir à faire des allers-retours. Cela se traduit par un processus de construction plus rapide et plus efficace qui vous fait gagner du temps et de l'argent. Voici tout ce que vous devez savoir pour rédiger un document d'exigences techniques clair et efficace.

Critères standard pour un document d'exigences techniques

Pour commencer, tous les documents d'exigences techniques efficaces ont les six éléments suivants en commun :

Clarté

Toutes les exigences techniques doivent être claires, courtes et sans ambiguïté afin d'éviter toute confusion. Moins c'est plus - souvent, une description d'une phrase suffira.

Nécessité

Pour éviter les confusions ou les contradictions, ne mettez dans votre DRE que les exigences absolument essentielles. Déterminez le pire scénario pour chaque exigence et s'il n'y a pas de conséquences, il n'est pas nécessaire qu'il soit dans votre ERD.

Coordonner

Les exigences techniques doivent être correctes tout au long de la conception du produit. Un ERD doit décrire toutes les exigences, les objectifs, les conditions et les capacités du produit. Dans la mesure du possible, expliquez ce que fait le produit de manière numérique pour plus de précision.

Testabilité

Chaque fois que vous écrivez une nouvelle exigence d'ingénierie, vous devez être en mesure de vérifier une mise en œuvre réussie. Il existe de nombreux types de méthodes de test pour assurer la vérifiabilité, y compris l'inspection, les tests utilisateur, les tests logiciels et les tests d'intégration système. Choisissez la méthode de test qui convient le mieux à votre projet.

Faisabilité

Restez dans les limites de ce qui peut être réalisé techniquement, ainsi que de ce qui est juridiquement, organisationnellement et financièrement possible. Soyez raisonnable et honnête, car la création d'exigences irréalisables entraînera des complications sur toute la ligne. Si la faisabilité ne peut être atteinte, vous pouvez indiquer un détail de conception comme un objectif plutôt qu'une exigence.

Traçabilité

Tout ingénieur examinant votre ERD devrait être en mesure de retracer chaque exigence jusqu'à l'objectif initial du produit. Relier les implémentations aux objectifs du produit permet d'expliquer pourquoi un élément est important, d'où il vient et comment il a du sens avec la conception globale de la pièce.

Conseils pour rédiger un bon document d'exigences techniques

Une fois que vous vous êtes assuré que les critères standard ont été pris en compte, vous pouvez mettre en œuvre les meilleures pratiques qui feront passer votre document d'exigences techniques au niveau supérieur. Voici cinq conseils pour rédiger un document d'exigences techniques de premier ordre.

Utilisez un modèle d'exigences techniques

Vous pouvez gagner du temps et de l'énergie au début d'un nouveau projet en utilisant un modèle de document d'exigences techniques. Un modèle ERD garantit que votre ERD est toujours correctement structuré. Au minimum, un modèle de document d'exigences techniques doit avoir une page de garde, des en-têtes de section et d'autres sections normalisées appelées « types ». Utilisez des passe-partout pour couvrir des sujets ERD tels que l'utilisation des verbes, les abréviations, les mots-clés, les normes de formatage et d'autres directives nécessaires à la compréhension de votre ERD.

Évitez d'écrire des opérations et des implémentations

Vos exigences en matière d'ingénierie doivent indiquer un objectif, et non comment l'objectif sera atteint. Si vous expliquez les étapes pour atteindre un objectif au lieu de l'objectif lui-même, vous n'écrivez pas vraiment un ERD - vous écrivez un guide d'opérations et de mise en œuvre. Si vous rédigez un guide d'utilisation et de mise en œuvre par erreur, un fabricant pourrait mal comprendre vos intentions et les objectifs de votre projet pourraient ne pas être atteints.

Pour vous assurer que vos exigences sont bien des exigences, demandez-vous pourquoi cette exigence est une partie nécessaire de votre document d'exigences techniques. Ayez confiance que les concepteurs et les fabricants du système détermineront comment l'objectif sera atteint et qu'ils le feront de la manière la plus efficace possible.

Évaluez votre DRE

Cela aidera à vérifier que toutes les exigences techniques répondent à vos objectifs déclarés et aux aspirations de votre entreprise. Pour une évaluation complète, il est préférable de constituer une équipe diversifiée. Cela implique de réunir des personnes de toutes races, ethnies et sexes pour évaluer votre document d'exigences techniques, mais également d'apporter une diversité de rôles à l'évaluation. Incluez autant de rôles que possible (concepteurs, développeurs, testeurs, représentants des utilisateurs finaux, responsables de la maintenance et de la gestion, et bien sûr l'équipe client) pour apporter de nombreuses informations précieuses à votre évaluation ERD.

Utilisez le bon langage

Il existe certaines règles linguistiques que vous devez toujours suivre lors de la rédaction d'un document d'exigences techniques. Les trois grands termes spécifiques à la DRE sont shall, will et should. "Shall" représente des exigences, "will" représente des faits et "should" représente des objectifs.

Un terme spécifique de la DRE qui est souvent utilisé à mauvais escient est le soutien. En termes d'ERD, "soutenir" fait référence à la capacité d'une structure à supporter ou à prendre du poids, et non à ce qu'elle soutienne ou accomplisse certaines capacités.

En général, évitez les termes tels que sont, est et était dans les exigences techniques elles-mêmes. Vous pouvez les utiliser dans une section descriptive ou menant à une exigence, mais évitez-les dans votre exigence elle-même pour promouvoir la spécificité. Vous devez également éviter les termes vagues tels que :

• Mais pas limité à ou etc. — Ces termes couvrent l'inconnu et il ne devrait y avoir rien d'inconnu ou d'imprévisible concernant votre DRE.
• Et/ou — Cela laisse trop d'options d'interprétation et de marge d'erreur, car un entrepreneur aura raison dans deux scénarios différents (s'il choisit ET ou s'il choisit OU).
• Mots faibles qui n'ont pas de signification quantitative. Cela inclut des adjectifs comme "puissant" et "efficace" ainsi que des verbes comme "améliorer" ou "renforcer". Essayez également d'éviter les comparaisons (par exemple, rapidement ou lentement, la plupart ou peu) et tout autre langage non quantitatif.

Lors de la rédaction des ERD, vous devez également éviter les déclarations négatives et vous concentrer sur l'existence d'un élément ou d'une capacité d'exigence. La seule fois où il est acceptable d'utiliser des spécifications négatives, c'est lorsque l'on met l'accent sur une situation potentiellement dangereuse. Même dans ces cas, assurez-vous d'énoncer également le dossier de sécurité.

Ne soyez pas trop précis

Bien qu'il existe de nombreuses règles linguistiques à suivre lors de la rédaction de votre document d'exigences techniques, restez simple. La clarté est essentielle pour les ERD, alors concentrez-vous uniquement sur les buts, objectifs et contraintes nécessaires à votre besoin. Ayez toujours une raison de mettre une exigence - trop d'exigences brouilleront votre ERD et confondront les lecteurs. Si vous sentez que vos exigences deviennent trop longues et compliquées, utilisez des puces pour diviser ses éléments.
Avoir un document d'exigences d'ingénierie (ERD) bien rédigé aidera les ingénieurs, les équipes de produits et les autres collaborateurs à mieux comprendre vos intentions de conception. En reliant clairement la conception d'un composant à ses objectifs spécifiques et à l'objectif général de la pièce, un ERD garantit qu'un produit est conçu de manière à satisfaire les besoins des clients.

Plus important encore, un excellent ERD favorise la collaboration, la communication et la clarté tout au long du processus de conception et de fabrication. Cela garantira que chaque partie est entièrement fonctionnelle et atteindra les objectifs souhaités. En plus d'assurer la cohérence d'une pièce à l'autre, un ERD favorise également des cycles de production plus rapides et des coûts réduits.

Que vous rédigiez votre premier document d'exigences techniques ou que vous soyez bien entraîné, Fast Radius est là pour vous aider à chaque étape du processus de développement et de production. Notre équipe de concepteurs, d'ingénieurs et de fabricants experts est là pour s'assurer que votre pièce atteint tous ses objectifs. Contactez-nous dès aujourd'hui.

Pour plus de ressources sur le développement de produits, visitez le centre d'apprentissage Fast Radius.

Prêt à fabriquer vos pièces avec Fast Radius ?

Commencez votre devis