Draft for Comments Kopfdaten
Herausgeberin: Forschungsstelle Digitale Ökonomie (Digi-Oek.ch)
DfC 1001
Kategorie: (3) Information
Autorinnen, Autoren, Mitarbeit (DfC 1003):
Redaktion: wue
Status: Entwurf
Aktuelle Version 0.1.8, Datum 2020-10-20
Datum erste Version: 2019-05-10
DOI:
Permalink: www.digi-oek.ch/dfc/dfc1001/
Änderungsprotokoll: /dfc1001-changelog.txt

  1. Einleitende Beschreibung «Draft for Comments» (DfC)
  2. Der Begriff «Draft for Comments» (DfC)
  3. DfC kann generisch und projektunabhängig verstanden werden
  4. DfC-Prozess und Qualitätsanforderung
    1. Wichtiges Merkmal des DfC-Prozesses
    2. Entwurf erarbeiten
    3. Kommentieren
    4. Werkzeug für das Kommentieren
    5. Einfache Überarbeitung und Versionierung
  5. DfC-Dokumenten-Kategorien
    1. Analyse, Bericht
    2. Experten-Standard, Mindestanforderungen für die Praxis
      1. Begriff
      2. Schlüsselwörter zum Kennzeichnen von Anforderungen
        1. Verwendung der Schlüsselwörter in DfC
    3. Essay, Aufsatz, Vortrag, Information
  6. DfC-Dokumenten-Status
    1. Status in den Kopfdaten
    2. Status-Anmerkungen im Text
  7. Lizenz
  8. Kommentieren dieses DfC
  9. Weiterführende Informationen
  10. Referenzen

Einleitende Beschreibung «Draft for Comments» (DfC)

Ein Draft for Comments (DfC) ist ein Entwurf eines Dokumentes, das zur Diskussion steht und zu Kommentaren, Beiträgen oder Korrekturen aufruft.

Ein DfC soll fachübergreifend verstanden werden. Im Rahmen dieses Projektes, Digi-Oek.ch, stehen allerdings Digitalthemen im Vordergrund. Digital darf breit ausgelegt werden.

Dieser DfC beschreibt im Grundsatz auch, wer den Entwurf wie erarbeitet und wer wie kommentiert.

Der Begriff «Draft for Comments» (DfC)

Der Begriff wird in der Ankündigung zum «Draft for Comments» (DfC) erläutert.

Die Abkürzung wird in der Einzahl als auch in der Mehrzahl DfC geschrieben, also nicht DfCs, nicht DFC oder nicht dfc.

DfC kann generisch und projektunabhängig verstanden werden

Ein hier beschriebener DfC und DfC-Prozess kann generisch genutzt werden, also auch für Projekte und Dokumente, die ihre Heimat nicht bei Digi-Oek.ch haben.

DfC-Prozess und Qualitätsanforderung

Wichtiges Merkmal des DfC-Prozesses

Ein Hauptmerkmal des DfC-Prozesses ist, dass die Kommentierung den vorgelegten Entwurf verbessern sollte. Expertise und Fachwissen von Dritten kann die Qualität, Aussagekraft und Akzeptanz einer DfC-Arbeit erhöhen.

Wie hingegen der Entwurf eines DfC erarbeitet wird, steht der Herausgeberin oder dem Herausgeber bzw. der verantwortlichen Redaktion oder der Autorin/dem Autor (gegebenenfalls mehreren)1 frei. Nachfolgend wird die Bezeichnung Herausgeberin, welche eine Organisation (Projekt, Person/en) sein kann, verwendet. Häufig, aber nicht immer, dürften die Autorin oder der Autor zu dieser Organisation oder zu diesem Projekt gehören. Sie kann auch weitere Personen anfragen, einen Text vorzulegen oder an einem Entwurf mitzuarbeiten.

Entwurf erarbeiten

Die Herausgeberin legt in der Regel einen Entwurf vor und legt die Kategorie fest.

Gegebenenfalls sinngemäss oder “relaxed” kann die für eine wissenschaftliche Arbeit gebräuchliche Systematik einer Forschungs- oder tertiären Bildungsinstitution nach Wahl angewandt werden, jedoch einheitlich pro DfC. Insbesondere müssen beachtet werden:

  • Quellenangaben sind in der Regel erforderlich, wenn sie nicht Allgemeinwissen betreffen.
  • Zitate müssen als solche erkenntlich sein.
  • Urheberrechte und gesetzliche Bestimmungen müssen eingehalten werden. Unrechtmässige Nachahmung (Plagiat) wird nicht toleriert.

Kommentieren

Personen aus Forschung und Praxis sowie mit Expertise oder Interesse dürfen sich eingeladen fühlen, den Entwurf zu kommentieren, zu kritisieren, zu vervollständigen oder zu verbessern.

Es können Textstellen eines Entwurfes oder der gesamte DfC kritisiert werden. Vorgeschlagene Textanpassungen sollen wenn immer möglich konkret formuliert werden.

Wenn die Kommentare in eine weitere Version des DfC-Textes einfliessen sollen, sind Quellenangaben in der Regel auch bei Kommentaren hilfreich oder erforderlich.

Werkzeug für das Kommentieren

Als Werkzeug wird eine Mailingliste empfohlen. Eine Mailingliste gilt als bewährtes Tool, wie es auch bei Organisationen mit vergleichbaren, grösseren Prozessen eingesetzt wird. Eine Mailingliste dürfte mit Abstand am einfachsten sein und den wohl geringsten Wartungsaufwand verursachen. Ein Werkzeug muss transparent überprüfbaren Anforderungen an Sicherheit und Privatshäre genügen2.

In einem Abschnitt eines jeden DfC sollte ein Verweis zum Werkzeug bekanntgegeben werden mit Angabe des Zeitraums, in welchem kommentiert und mitgearbeitet werden kann.

Einfache Überarbeitung und Versionierung

Die Herausgeberin entscheidet, wann und ob Kommentare in eine neue DfC-Version einfliessen. Angelehnt an die Versionierungs-Usanz bei Software, genügt hier meistens eine Haupt- und eine Nebenversionsnummer. Die Ziffern werden durch einen Punkt getrennt, Beispiele: 0.1 oder 2.4 usw. Eventuell zusätzlich eine Revisionsnummer, Beispiel: 2.3.4 usw. Ein Änderungsprotokoll dokumentiert die wichtigsten Anpassungen seit der letzten Version in einer unverlinkten Datei relativ zum DfC, Beispiel: /dfc1001-changelog.txt für den DfC 1001; die URL kann dann so aussehen: https://www.projektname.tld/dfc/dfc1001/dfc1001-changelog.txt

DfC-Dokumenten-Kategorien

Drei Dokumenten-Kategorien werden vorgeschlagen:

  1. Analyse, Bericht

  2. Experten-Standard, Mindestanforderungen für die Praxis

  3. Essay, Aufsatz, Vortrag, Information

DfC-Dokumenten-Kategorien und DfC-Kategorien werden synonym betrachtet.

Analyse, Bericht

Mit dieser DfC-Kategorie soll ein Vorschlag, ein Entwurf (eines Textes) zum gegebenen thematischen Schwerpunkt3, eine Idee oder eine Analyse erarbeitet werden.

Experten-Standard, Mindestanforderungen für die Praxis

Begriff

Als Begriff für DfC in dieser Kategorie schlagen wir einerseits Experten-Standard und andererseits Mindestanforderungen für die Praxis (Best oder Current Practice) vor: Auf eine vereinfachte und vergleichsweise schnelle Weise soll ein solcher DfC als Richtlinie oder Mindestanforderungen für die Praxis erarbeitet werden können. Denkbar wäre, dass solche DfC eigenständige Standard-Vorschläge bleiben oder aber als Basis für formellere Standards dienen können.

Schlüsselwörter zum Kennzeichnen von Anforderungen

RFC 21194, “Key words for use in RFCs to Indicate Requirement Levels”, spezifiziert, dass in vielen Standardisierungsverfahren Schlüsselwörter verwendet werden: “Schlüsselwörter zum Kennzeichnen von Anforderungen, um Anforderungen der Spezifikation aufzuzeigen”5.

Der RFC 2119 wurde mit der Bezeichnung 2119de “in die deutsche Sprache interpretiert. Es handelt sich dabei nicht um eine wortgetreue Übersetzung, sondern um eine Interpretation in Deutsch.”6

RFC 81747 reduziert die Mehrdeutigkeit solcher Schlüsselwörter: diese seien immer GROSS zu schreiben, wenn sie in Standards die spezielle Schlüsselwörter-Bedeutung ausdrücken sollen,

Für «Drafts for Comments» (DfC) wird EMPFOHLEN, sich ebenfalls an

  • RFC 2119
  • 2119de als deutschsprachige Version des RFC 2119
  • RFC 8174, deutschsprachig sinngemäss (Schlüsselwörter immer GROSS schreiben)

zu halten und, sofern möglich und passend, die hervorgehobenen Schlüsselwörter gemäss folgender Tabelle zu bevorzugen. Die Schlüsselwörter werden in der DfC-Kategorie “Experten-Standard, Mindestanforderungen für die Praxis” verwendet. In anderen DfC können sie ausnahmsweise angewendet werden, insbesondere in Kapiteln mit Standard-Charakter.

Schlüsselwörter
2119de, Präferenz DfC		 Key words
RFC 2119
MUSS
ERFORDERLICH, NÖTIG		 MUST, REQUIRED or SHALL
DARF NICHT
VERBOTEN		 MUST NOT, SHALL NOT
EMPFOHLEN
SOLL		 SHOULD, RECOMMENDED
NICHT EMPFOHLEN
SOLL NICHT		 SHOULD NOT, NOT RECOMMENDED
OPTIONAL
DARF, NICHT NÖTIG		 MAY, OPTIONAL
Präferenz für DfC ist hervorgehoben (zu bevorzugen sofern passend).
Ferner gilt gemäss 2119de: “Alle Schlüsselwörter DÜRFEN dekliniert und konjugiert werden. […] Konjunktiv ist VERBOTEN”.
Einzelheiten und Begriffserklärungen in 2119de.
Verwendung der Schlüsselwörter in DfC

Gemäss 2119de5 sollen Autoren mit einem Satz in ihrem Dokument darauf hinweisen, dass die Schlüsselwörter verwendet werden. Diese EMPFEHLUNG wird für DfC ebenfalls übernommen und SOLL so formuliert werden:

Autorinnen und Autoren, die diesen Richtlinien folgen, sollten den folgenden Satz am Anfang ihres DfC-Dokumentes einfügen:
Die Schlüsselwörter
"MUSS" ("ERFORDERLICH", "NÖTIG"),
"DARF NICHT" ("VERBOTEN"),
"EMPFOHLEN" ("SOLL"),
"NICHT EMPFOHLEN" ("SOLL NICHT"),
"OPTIONAL" ("DARF", "NICHT NÖTIG")
werden nach DfC 1001, in Anlehnung
an RFC 2119 bzw. 2119de, interpretiert.
https://www.digitale-oekonomie.ch/dfc/dfc1001/

Es wird EMPFOHLEN, in deutschsprachigen DfC die deutschsprachigen Schlüsselwörter zu verwenden.

OPTIONAL können die Schlüsselwörter in eckige Klammern [] gesetzt werden, um sie besser hervorzuheben oder um sie beispielsweise am Ende eines Satzes oder in einer Tabelle anzufügen: [MUSS], [DARF NICHT], [EMPFOHLEN], [NICHT EMPFOHLEN] oder [OPTIONAL] und gegebenenfalls oben angegebene, gleichwertige Schlüsselwörter.

Essay, Aufsatz, Vortrag, Information

Diese Kategorie kann für

  • einen Aufsatz, also eine “kürzere Abhandlung über ein bestimmtes Thema” (mit u. a. dem Beispiel: “einen [wissenschaftlichen] Aufsatz veröffentlichen”)8,
  • ein Essay, also eine “Abhandlung, die eine literarische oder wissenschaftliche Frage in knapper und anspruchsvoller Form behandelt”9
  • einen Vortrag, eine Präsentation
  • sowie für informationelle oder informative DfC

verwendet werden.

In diese Kategorie fallen auch DfC, welche über den DfC selber informieren.

DfC-Dokumenten-Status

Status in den Kopfdaten

In den Draft for Comments Kopfdaten kann ein Status angegeben werden:

  1. Experimentell
  2. Entwurf
    • Eine optionale Unterteilung in “Früher Entwurf” (Early Draft) und “Entwurf” ist möglich.
  3. Final oder Finaler Entwurf

Ein Draft for Comments bleibt ein “Draft for Comments”. Das Wort “Draft” bleibt ähnlich wie bei anderen Kommentier-Konzepten erhalten10. Der “finale” Status kann “Finaler Entwurf” heissen, wenn seine Vorläufigkeit ausgedrückt werden soll, insbesondere bei zeitlich unbegrenzt möglicher Kommentierung im Kapitel Kommentieren dieses DfC eines jeden DfC. Dies ist die bevorzugte Bezeichnung für einen (vorläufig) “finalen” Status, wenn ein DfC aus inhaltlichen Gründen kein Ablaufdatum hat. Eine Debatte darüber soll ebenfalls geführt werden.

Status-Anmerkungen im Text

Im Text, beispielsweise am Anfang oder Schluss eines Kapitels oder eines Abschnitts, können Status-Anmerkungen oder Hinweise auf besonders erwünschte Kommentare eingefügt werden, zum Beispiel:

[DfC]: Expertise, Meinungen, Diskussion erwünscht!

oder beispielsweise:

[DfC]: Prüfung, Ergänzungen, Korrekturen, Verbesserungen von Fachpersonen erwünscht.

Lizenz

Die Inhalte der DfC stehen unter einer der folgenden Lizenzen:

  • Lizenz CC BY-SA 4.011
  • Lizenz CC BY-SA 3.0 CH12

Ausnahmen kann die Herausgeberin oder der Herausgeber bzw. die verantwortliche Redaktion gewähren, wenn eine andere Lizenz für einen bestimmten DfC besser geeignet ist und in der Forschung häufig vorkommt.

Kommentieren dieses DfC

[Vorgeschlagene Beispiel-Formulierung. Da dies der DfC 1001 des Projektes Digi-Oek.ch ist, gilt diese auch gleichzeitig als echter Hinweis auf das Kommentar-Werkzeug.]

Dieser DfC kann auf der Mailingliste oder in weiteren Foren dieses Projektes Digi-Oek.ch kommentiert werden.

Zeitraum, Fristen: Kommentierung zeitlich unbegrenzt möglich

Weiterführende Informationen

Referenzen

  1. Zu den DfC-Autorinnen und Autoren siehe DfC 1003 ↩

  2. Ein DfC, der diese beschreibt, ist vorgesehen. Andererseits gibt es zahlreiche gute Einführungen ins Thema. ↩

  3. In diesem Projekt sind Digitalthemen der Schwerpunkt. ↩

  4. Bradner S., “Key words for use in RFCs to Indicate Requirement Levels”, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>. ↩

  5. Fuchs Jean-Louis, “Schlüsselwörter zum Kennzeichnen von Anforderungen”, 2119de, 15. April 2017, <https://github.com/adfinis-sygroup/2119/blob/master/2119de.rst>. ↩ ↩2

  6. Fuchs Jean-Louis, Adfinis AG, “Interpretation des RFC 2119 in deutscher Sprache”, 15. April 2017, <https://adfinis.com/blog/german-interpretation-of-rfc-2119/>. ↩

  7. Leiba B., “Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words”, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/info/rfc8174>. ↩

  8. “Aufsatz” in: Duden, <https://www.duden.de/rechtschreibung/Aufsatz> ↩

  9. “Essay” in: Duden, <https://www.duden.de/rechtschreibung/Essay> ↩

  10. Dazu mehr, wenn auch in anderen Teilen nicht vergleichbaren: “Der Begriff «Draft for Comments» (DfC)” in Vorschlag für einen «Draft for Comments» (DfC). ↩

  11. Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) gemäss den Bestimmungen unter: <https://creativecommons.org/licenses/by-sa/4.0/> ↩

  12. Namensnennung - Weitergabe unter gleichen Bedingungen 3.0 Schweiz (CC BY-SA 3.0 CH) gemäss den Bestimmungen unter: <https://creativecommons.org/licenses/by-sa/3.0/ch/> ↩