Basierend auf RFC 2119 definiert dieses Dokument Schlüsselwörter zum Kennzeichen von Anforderungen. Dies ist keine Übersetzung, sondern eine Interpretation für Deutschsprachige, damit dieses großartige Werkzeug auch für deutsche Dokumentationen eingesetzt werden kann.
Im Standardisierungsverfahren werden in vielen Dokumenten Schlüsselwörter verwendet, um Anforderungen der Spezifikation aufzuzeigen. Diese Wörter werden oft groß geschrieben. Autoren, die diesen Richtlinien folgen, sollten den folgenden Satz am Anfang ihres Dokuments einfügen:
Die Schlüsselwörter "MUSS", "DARF NICHT", "ERFORDERLICH", "SOLL",
"VERBOTEN", "NÖTIG", "NICHT NÖTIG", "SOLL NICHT", "EMPFOHLEN", "DARF",
"KANN" und "OPTIONAL" werden nach 2119de interpretiert.
https://goo.gl/6QZH4JBeachten Sie, dass die Aussagekraft dieser Worte, durch die Anforderungen des Dokuments, in welchem sie verwendet werden, relativiert werden können.
- MUSS
sowie die Schlüsselwörter "ERFORDERLICH" und "NÖTIG" bedeuten, dass die Definition eine absolute Anforderung der Spezifikation ist.
- DARF NICHT
und das Wort "VERBOTEN" bedeuten, dass die Definition ein absolutes Verbot der Spezifikation ist.
- SOLL
und das Adjektiv "EMPFOHLEN" respektive das Verb "EMPFEHLEN" bedeuten, dass es in speziellen Situationen Gründe geben kann, diese Spezifikation zu ignorieren. Natürlich müssen die Auswirkungen voll und ganz verstanden und sorgfältig abgewägt werden bevor von der Spezifikation abgewichen wird.
- SOLL NICHT
und "NICHT EMPFOHLEN" bedeuten, dass es gute Gründe in speziellen Situationen geben kann, dass dieses Verhalten akzeptabel, ja sogar nützlich sein kann. Natürlich müssen die Auswirkungen voll und ganz verstanden und sorgfältig abgewägt werden bevor von der Spezifikation abgewichen wird.
- DARF
sowie "KANN", "NICHT NÖTIG" und das Adjektiv "OPTIONAL" bedeuten, dass dieses Verhalten wirklich optional ist.
Wichtig bei der Definition einer Interaktion oder Protokolls: Ein Anbieter kann entscheiden dieses Verhalten einzuschliessen, weil es das Produkt verbessert oder für einen speziellen Markt erforderlich ist. Ein anderer Anbieter kann dieses Verhalten weglassen. Eine Implementation, die dieses Verhalten weglässt, MUSS bereit sein, mit einer anderen Implementation welche dieses Verhalten einschliesst, zu interagieren. In derselben Art MUSS eine Implementation, die dieses Verhalten einschließt, mit einer Implementation, die dieses Verhalten weglässt, interagieren können.
Anmerkung für's Deutsche: Alle Schlüsselwörter DÜRFEN dekliniert und konjugiert werden. Die Verwendung der vorgeschlagenen Verben im Konjunktiv ist VERBOTEN. Die Großschreibung ist ausreichend, um die Schlüsselwörter zu erkennen. "NICHT" kann mit "KEIN" ersetzt werden, wie es im Deutschen üblich ist.
Leitlinie für die Verwendung
Die Grundsätze, die in diesem Memo definiert sind, sollen sparsam und mit Sorgfalt eingesetzt werden. Im Speziellen ist es NÖTIG, sie nur dort zu benutzen, wo es für die Interaktion wichtig ist oder um nachteiliges Verhalten auszuschliessen. Sie DÜRFEN KEINE Implementationsdetails vorschreiben, welche unabhängig von der Interaktion sind.
Sicherheitsbedenken
Diese Begriffe werden oft verwendet, um sicherheitsrelevantes Verhalten zu definieren. Ein "MUSS" oder "SOLL" wegzulassen oder etwas zu tun, das als "DARF NICHT" oder "SOLL NICHT" definiert ist, kann subtile Auswirkungen haben. Autoren sollten sich Zeit nehmen, um über Sicherheitsauswirkungen nachzudenken, da die Anwender des Dokuments unter Umständen nicht über dieselbe Erfahrung und Hintergrundwissen verfügen.
Ich danke den Autoren des RFCs 2119, welches es mir ermöglicht hat, 2119de zu schreiben.
Die Definitionen basieren auf existierenden RFCs. Zusätzlich sind Anmerkungen einer Reihe von weiteren Personen eingeflossen, unter anderem Robert Ullmann, Thomas Narten, Neal McBurnett and Robert Elz.
Autor des orginal RFCs 2119:
Scott Bradner
email - sob@harvard.eduAutor:
Jean-Louis Fuchs
email - ganwell@fangorn.ch