Een document met technische vereisten schrijven

Een document met technische vereisten (ERD) is een verklaring die het doel en het doel van een nieuw onderdeel beschrijft. In tegenstelling tot een document met productvereisten (PRD), dat ingenieurs vertelt wat ze moeten bouwen, specificeert een ERD waarom een ​​onderdeel wordt gebouwd en hoe het ontwerp ervan bijdraagt ​​aan het doel ervan. Door de technische vereisten te volgen die in een ERD zijn uiteengezet, kunnen ingenieurs ervoor zorgen dat het onderdeel dat ze bouwen aan de behoeften van de klant zal voldoen. Het gebruik van een ERD helpt ook om de productie op verschillende manieren te stroomlijnen:

• ERD's gebruiken gedefinieerde en consistente communicatie om samenwerking te bevorderen, miscommunicatie te verminderen en iedereen op één lijn te houden.
• ERD's helpen bij het opdelen van grote projecten in kleinere taken, waardoor ze gemakkelijker kunnen worden gedelegeerd of uitbesteed.
• ERD's kunnen worden vergeleken met PRD's om ervoor te zorgen dat alle ontwerpintenties correct worden geïmplementeerd en dat alle productdoelen worden bereikt.

Een goed geschreven ERD stelt ingenieurs en fabrikanten in staat om kritische vragen over het ontwerp en het doel van onderdelen te beantwoorden zonder heen en weer te hoeven gaan. Dit resulteert in een sneller en efficiënter bouwproces waarmee u tijd en geld bespaart. Hier vindt u alles wat u moet weten om een ​​duidelijk en effectief document met technische vereisten te schrijven.

Standaardcriteria voor een document met technische vereisten

Om te beginnen hebben alle effectieve documenten met technische vereisten de volgende zes elementen gemeen:

Helderheid

Alle technische vereisten moeten duidelijk, kort en ondubbelzinnig zijn om verwarring te voorkomen. Minder is meer — vaak is een beschrijving van één zin voldoende.

Noodzaak

Om verwarring of tegenstrijdigheden te voorkomen, zet u alleen de absoluut noodzakelijke vereisten in uw ERD. Bepaal het worstcasescenario voor elke vereiste en als er geen gevolgen zijn, hoeft het niet in uw ERD te staan.

Coördinatie

Technische vereisten moeten tijdens het productontwerp correct zijn. Een ERD moet alle productvereisten, doelen, voorwaarden en mogelijkheden beschrijven. Leg waar mogelijk uit wat het product doet op een numerieke manier voor de meeste precisie.

Testbaarheid

Telkens wanneer u een nieuwe technische vereiste schrijft, moet u een succesvolle implementatie kunnen verifiëren. Er zijn veel verschillende soorten testmethoden om de verifieerbaarheid te garanderen, waaronder inspectie, gebruikerstests, softwaretests en systeemintegratietests. Kies de testmethode die het meest geschikt is voor uw project.

Haalbaarheid

Blijf binnen de grenzen van wat technisch mogelijk is, maar ook wat juridisch, organisatorisch en financieel mogelijk is. Wees redelijk en eerlijk, aangezien het creëren van niet-haalbare vereisten tot complicaties zal leiden. Als de haalbaarheid niet kan worden bereikt, kunt u een ontwerpdetail als doel opgeven in plaats van als vereiste.

Traceerbaarheid

Elke ingenieur die naar uw ERD kijkt, moet elke vereiste kunnen herleiden tot het doel van het oorspronkelijke product. Door implementaties terug te koppelen aan productdoelen, wordt uitgelegd waarom een ​​element belangrijk is, waar het vandaan komt en hoe het past bij het algehele ontwerp van het onderdeel.

Tips voor het schrijven van een goed document met technische vereisten

Zodra u er zeker van bent dat er rekening is gehouden met de standaardcriteria, kunt u best practices implementeren die uw document met technische vereisten naar een hoger niveau tillen. Hier zijn vijf tips voor het schrijven van een eersteklas document met technische vereisten.

Gebruik een sjabloon voor technische vereisten

U kunt aan het begin van een nieuw project tijd en energie besparen door een documentsjabloon voor technische vereisten te gebruiken. Een ERD-template zorgt ervoor dat uw ERD altijd goed gestructureerd is. Een documentsjabloon met technische vereisten moet minimaal een voorblad, sectiekoppen en andere gestandaardiseerde secties hebben die bekend staan ​​als 'boilerplates'. Gebruik standaardteksten om ERD-onderwerpen te behandelen, zoals het gebruik van werkwoorden, afkortingen, trefwoorden, opmaaknormen en andere richtlijnen die nodig zijn om uw ERD te begrijpen.

Vermijd schrijfbewerkingen en implementaties

Uw technische vereisten moeten een doel vermelden, niet hoe het doel zal worden bereikt. Als u de stappen voor het voltooien van een doel uitlegt in plaats van het doel zelf, schrijft u niet echt een ERD - u schrijft een handleiding voor bewerkingen en implementatie. Als u per ongeluk een handleiding voor bewerkingen en implementaties schrijft, kan een fabrikant uw bedoelingen verkeerd begrijpen en worden uw projectdoelen mogelijk niet gehaald.

Om ervoor te zorgen dat uw vereisten inderdaad vereisten zijn, moet u zich afvragen waarom deze vereiste een noodzakelijk onderdeel is van uw document met technische vereisten. Vertrouw erop dat de systeemontwerpers en fabrikanten zullen bepalen hoe het doel zal worden bereikt en dat ze dit op de meest efficiënte manier zullen doen.

Evalueer uw ERD

Dit zal helpen verifiëren dat alle technische vereisten voldoen aan uw gestelde doelen en bedrijfsambities. Voor een goed afgeronde evaluatie kun je het beste een divers team samenstellen. Dit omvat het samenbrengen van mensen van alle rassen, etniciteiten en geslachten om uw document met technische vereisten te evalueren, maar omvat ook het toevoegen van een diversiteit aan rollen aan de evaluatie. Voeg zoveel mogelijk rollen toe:ontwerpers, ontwikkelaars, testers, vertegenwoordigers van eindgebruikers, degenen die verantwoordelijk zijn voor onderhoud en beheer, en natuurlijk het klantteam, om tal van waardevolle inzichten in uw ERD-evaluatie te brengen.

Gebruik de juiste taal

Er zijn enkele taalregels die u altijd moet volgen bij het schrijven van een document met technische vereisten. De grote drie ERD-specifieke termen zijn zullen, willen en moeten. "Zullen" staat voor vereisten, "zal" voor feiten en "zouden" voor doelen.

Een specifieke ERD-term die vaak misbruikt wordt, is ondersteuning. In ERD-termen verwijst "ondersteuning" naar het vermogen van een structuur om gewicht te houden of te dragen, niet dat het bepaalde capaciteiten zal ondersteunen of bereiken.

Blijf in het algemeen weg van termen als zijn, is en was in de technische vereisten zelf. U kunt ze gebruiken in een beschrijvend gedeelte of leidend tot een vereiste, maar vermijd ze in uw vereiste zelf om specificiteit te bevorderen. Vermijd ook vage termen zoals:

• Maar niet beperkt tot of etc. — Deze voorwaarden dekken het onbekende en er mag niets onbekends of onvoorspelbaars zijn aan uw ERD.
• En/of — Dit laat te veel interpretatiemogelijkheden en ruimte voor fouten, omdat een aannemer in twee verschillende scenario's gelijk heeft (als hij kiest voor EN of als hij kiest voor OF).
• Zwakke woorden die geen kwantitatieve betekenis hebben. Dit omvat bijvoeglijke naamwoorden zoals 'krachtig' en 'efficiënt', evenals werkwoorden als 'verbeteren' of 'versterken'. Probeer ook vergelijkingen (bijvoorbeeld snel of langzaam, de meeste of weinig) en andere niet-kwantitatieve taal te vermijden.

Bij het schrijven van ERD's moet u ook negatieve verklaringen vermijden en u concentreren op het bestaan ​​van een element of vermogen van een vereiste. De enige keer dat het acceptabel is om negatieve specificaties te gebruiken, is bij het benadrukken van een potentieel gevaarlijke situatie. Zorg er zelfs in deze gevallen voor dat u ook de veiligheidskwestie vermeldt.

Wees niet te specifiek

Hoewel er veel taalregels zijn die u moet volgen bij het schrijven van uw document met technische vereisten, moet u het eenvoudig houden. Duidelijkheid is de sleutel voor ERD's, dus concentreer u alleen op de noodzakelijke doelen, doelstellingen en beperkingen van uw vereiste. Zorg altijd voor een reden om een ​​vereiste in te voeren - te veel vereisten zullen uw ERD in de war brengen en lezers in verwarring brengen. Als u vindt dat uw vereisten te lang en ingewikkeld worden, gebruik dan opsommingstekens om de elementen op te splitsen.
Het hebben van een goed geschreven document met technische vereisten (ERD) helpt ingenieurs, productteams en andere medewerkers om uw ontwerpintenties beter te begrijpen. Door het ontwerp van een component duidelijk te koppelen aan de specifieke doelen en het algemene doel van het onderdeel, zorgt een ERD ervoor dat een product zo wordt gebouwd dat het aan de behoeften van de klant voldoet.

Het belangrijkste is dat een geweldige ERD samenwerking, communicatie en duidelijkheid bevordert tijdens het ontwerp- en productieproces. Dit zorgt ervoor dat elk onderdeel volledig functioneel is en de gewenste doelstellingen zal bereiken. Een ERD zorgt niet alleen voor consistentie tussen onderdelen, maar bevordert ook snellere productieruns en lagere kosten.

Of u nu uw eerste document met technische vereisten schrijft of goed geoefend bent, Fast Radius is er om u te helpen in elke fase van het ontwikkelings- en productieproces. Ons team van deskundige ontwerpers, ingenieurs en fabrikanten is hier om ervoor te zorgen dat uw onderdeel al zijn doelen bereikt. Neem vandaag nog contact met ons op.

Ga voor meer bronnen over productontwikkeling naar het Fast Radius-leercentrum.

Klaar om uw onderdelen te maken met Fast Radius?