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


  1. Einleitung
  2. Konventionen
    1. Anforderungen an DfC-Dokumente
    2. Gestaltungsrichtlinie (Styleguide)
      1. Referenzen und Verlinkung
    3. Vorlage (Template)
  3. Struktur eines DfC
    1. Struktur eines DfC der Kategorie “Analyse, Bericht”
    2. Struktur eines DfC der Kategorie “Experten-Standard, Mindestanforderungen für die Praxis”
    3. Struktur eines DfC der Kategorie “Essay, Aufsatz, Vortrag, Information”
  4. Kommentieren dieses DfC
  5. Lizenz
  6. Weiterführende Informationen
  7. Referenzen

Einleitung

Dieses Dokument behandelt die Struktur eines DfC sowie weitere Konventionen.

Dieser DfC ist in einem frühen Entwicklungsstand. Kommentare mit Verbesserungsvorschlägen sind besonders erwünscht.

Konventionen

Anforderungen an DfC-Dokumente

Auch für die Anforderungen an DfC-Dokumente gilt, dass ein DfC mit eher geringen Ressourcen machbar sein soll1. Somit wird empfohlen, ein durchdachtes und an den DfC angepasstes Dokument zu erstellen und dieses mit Kritik des Kommentar-Prozesses 1 zu verfeinern. Eine einfache, übersichtliche Dokumenten-Struktur heisst nicht, dass die Qualität unangemessen ist.

Gestaltungsrichtlinie (Styleguide)

Wir schlagen vor, die Gestaltungsrichtlinien zu ergänzen, wenn Erfahrungen des DfC-Prozesses vorliegen. Vorerst soll die nachgenannte Struktur eines DfC als Richtlinie dienen. Mithilfe an der Ausarbeitung ist erwünscht. Bisher liegt vor:

Referenzen und Verlinkung

Referenzen bzw. Zitatnachweise werden als Fussnoten unter der vorangestellten Kapitelüberschrift “Referenzen” angefügt. Ein Zitatnachweis parenthetisch im Fliesstext wird vermieden. Sofern es sich bei den Referenzen um eine Internetseite handelt, wird in der Regel die URL ohne Verlinkung eingefügt: <URL>. Andere DfC, nicht aber andere Seiten eines Projektes, können im Fliesstext verlinkt oder ebenfalls als Fussnoten angefügt werden. DfC 1001, DfC 1002, DfC 1003 und DfC 1004, welche sozusagen sich selber erläutern, werden in der Regel im Fliesstext verlinkt.

Vorlage (Template)

Eine Vorlage mit Gestaltungsrichtlinien und Dokumentenstruktur existiert vorerst als einfache Muster-Vorlage und Platzhalter, DfC 1999. Mithilfe an der weiteren Ausarbeitung ist erwünscht.

Struktur eines DfC

Bis auf Weiteres wird folgende DfC-Dokumenten-Struktur vorgeschlagen:

Struktur eines DfC der Kategorie “Analyse, Bericht”

Pro Punkt in der Dokumentenstruktur sind mehrere Begriffe denkbar:

  1. Einleitung, Zusammenfassung, Summary, Inhaltsangabe (ausformuliert), Abstract
    • Eine Unterteilung in Zusammenfassung/Summary und Einleitung/Einführung/Introduction kann sinnvoll sein.
  2. Vorgehen, Methoden, Erklärungen, Schilderung des Themas oder der Problematik, Annahmen
  3. Analyse mit ihren Erkenntnissen, Resultaten, Ergebnissen
  4. Diskussion
  5. Fazit, Schlussfolgerungen/Folgerungen, Conclusions
  6. Lizenz
    • Eventuell Verweis auf das Kapitel “Verweis” in DfC 1001
  7. Kommentieren dieses DfC
  8. Weiterführende Informationen, Anhang
  9. Referenzen, Literatur

Optional können relevante Teile des RFC 73222, insbesondere “4. Structure of an RFC”, sinngemäss übernommen werden.

Eine ähnliche Struktur ist durchaus akzeptabel. Bei Bedarf werden Kapitel weggelassen oder hinzugefügt, die Titel können anders lauten. Es soll also zumindest vorläufig keine starre Struktur vorgegeben werden.

Struktur eines DfC der Kategorie “Experten-Standard, Mindestanforderungen für die Praxis”

Die Struktur kann sich an die Kategorie “Analyse, Bericht” anlehnen. Wir empfehlen insbesondere folgende Anpassungen zu erwägen:

  1. Einleitung
  2. Anwendungsbereich, Geltungsbereich, Scope
  3. (eventuell) normative Referenzen 3
  4. Bedingungen, Terms, eventuell Analyse
  5. Diskussion
  6. Fazit (anwendungsorientiert, für die Praxis)
  7. Kommentieren dieses DfC
  8. Lizenz
  9. Weiterführende Informationen, Anhang, Schemata
  10. Referenzen, Literatur

Optional können relevante Teile der ISO-Direktive4 bedingt zur Dokumenten-Struktur verwendet werden: Diese erscheinen sehr umfangreich, was dem DfC-Prinzip der Einfachheit nicht gerecht würde. Insbesondere der Teil “Subdivisions of the Document” könnten gegebenenfalls Anhaltspunkte geben.

Struktur eines DfC der Kategorie “Essay, Aufsatz, Vortrag, Information”

Die Struktur dieser Kategorie ist frei. Sie kann sich, falls sinnvoll, an der Kategorie “Analyse, Bericht” orientieren.

Bei Informations-DfC können die folgenden Kapitel am Schluss angehängt werden:

  • Kommentieren dieses DfC
  • Weiterführende Informationen
  • Referenzen

Kommentieren dieses DfC

Dieser DfC kann auf der Mailingliste (Einstiegsseite) dieses Projektes Digi-Oek.ch kommentiert werden: https://www.digitale-oekonomie.ch/mailman/listinfo/dfc_digi-oek.ch_digitale-oekonomie.ch

Zeitraum, Fristen: Kommentierung unbegrenzt möglich

Lizenz

Die Inhalte dieses DfC stehen unter der Lizenz CC BY-SA 4.01. Weitere Informationen können im DfC 1001 nachgelesen werden.

Weiterführende Informationen

Referenzen

  1. Vgl. DfC 1001 und DfC 1004 2 3

  2. Flanagan Heather and Sandy Ginoza. “RFC Style Guide”, “4. Structure of an RFC”. RFC 7322, DOI 10.17487/RFC7322, September 2014, <https://www.rfc-editor.org/info/rfc7322> 

  3. Sinngemäss nach Ausführungen zu normativen Referenzen des World Wide Web Consortium (W3C) [en]: “Normative References”. W3C, 2019-06-14, <https://www.w3.org/2013/09/normative-references> 

  4. “Directives ISO/IEC, Partie 2. Principes et règles de structure et de rédaction des documents ISO et IEC”. ISO, Eight Editon 2018, <https://www.iso.org/sites/directives/current/part2/index.xhtml>