Skip to content

Autorenrichtlinien für das NFDI4Earth Living Handbook

Das NFDI4Earth Living Handbook bietet eine (i) Enzyklopädie-artige Dokumentation der NFDI4Earth, ihrer Dienste und Ergebnisse in einer menschenlesbaren Form und (ii) hat das Ziel, alle Informationen rund um die Themen Datenmanagement und Datenwissenschaften in den Erdsystemschaften in einem Community-getriebenen Prozess zu strukturieren und zu harmonisieren. Diese Richtlinien fassen alle wichtigen Informationen für die Vorbereitung und Einreichung eines Artikel für das NFDI4Earth Living Handbook zusammen. Wie Artikel nach ihrer Einreichung verarbeitet werden, wird im Artikel über den editorischen Prozess beschrieben.

Einreichung von Artikel

Artikel können zur Zeit ausschließlich via Email an incoming+nfdi4earth-livinghandbook-livinghandbook-79252-issue-@mail.git.rwth-aachen.de eingereicht werden.

Inhalt

Artikel des Living Handbook fassen bereits vorhandenes Wissen zusammen; sie beinhalten üblicherweise keine Erstveröffentlichgungen von Forschungsergebnissen. Nichtsdestotrotz muss ihr Inhalt aus verlässlichen Quellen stammen. Idealerweise werden diese an den entsprechenden Stellen zitiert und am Ende des Artikels aufgelistet.

Beim Verfassen eines Artikels sollte der Inhalt so gut wie möglich den Prinzipien des "Spiral out" folgen. Dies bedeutet:

  • Beginne mit dem Kern des Themas
  • Beschreibe kurz sämtliche wichtigen Aspekte des Themas
  • Beschreibe alle oder einige dieser Aspekte im Detail

Dieser Ansatz ermöglicht auch mit dem Thema unvertrauten Lesenden einen schnellen Einstieg, da vor dem Fachwissen die Grundlagen des Themas vermittelt werden. Außerdem können Lesende so problemlos aufhören den Artikel zu lesen, sobald sie die für sie notwendigen Informationen und Detailtiefe erreicht haben.

Artikel haben keine feste minimale und maximale Länge. Üblicherweise sind sie zwischen 500 und 5000 Wörtern lang. Für die Lesbarkeit ist es überdies hilfreich, komplexe Themen auf mehrere Artikel aufzuteilen statt zu versuchen das Thema in einem Artikel zu behandeln. Generell wird empfohlen, bei Zweifeln ein Thema auf mehrere Artikel aufzuteilen und diese gegebenenfalls als "Collection)" zu bündeln.

Sämtliche nicht direkt in den Text eingebetteten Elemente (z. B. Info-Boxes, Code-Schnipsel, Formeln) müssen eine (Bild)unterschrift haben. Der Text muss Querverweise zu all diesen Elementen enthalten.

Verlinkungen zwischen Artikeln sind ausdrücklich erwünscht. Links zwischen Artikeln werden als [Link text](artikel.md) geschrieben. Mit [Link text](artikel.md#kapitel) wird auf Kapitel innerhalb eines Artikels verlinkt. Links zu externen Resourcen wie Webseiten und Abschnitten darin werden analog geschrieben, wobei artikel.md durch die vollständige URL der Seite ersetzt wird.

Quellenverweise

Im Artikel muss auf die Inhalte belegenden verlässliche Quellen verweisen werden. Die genutzten Quellen werden am Ende des Artikels im Quellenverzeichnis aufgelistet. Es dürfen ausschließlich die im Text verwendeten Quellen im Quellenverzeichnis aufgeführt werden. Beinhaltet ein Artikel Quellenverweise, so lautet die letzte Zeile des Manuskripts ## Quellenverzeichnis. Darunter darf ausschließlich das Quellenverzeichnis im bibtex-Format stehen, sofern es nicht in einer separaten Datei eingereicht wird.

Falls die zitierte Quelle eine DOI besitzt, ist die Angabe dieser ausreichend. Es wird jedoch empfohlen, das vollständige Zitat anzugeben, falls die entsprechenden Informationen nicht über die DOI abgerufen werden kann. Idealerweise ist das Quellenverzeichnis bibtex-formatiert. Bibliographische Informationen in diesem Format können in beliebiger Reihenfolge der Quellen vorliegen, es besteht keine Notwendigkeit der Sortierung z. B. nach dem Alphabet.

Bibtex ist ein weit verbreiteter Standard für die maschinenlesbare Codierung bibliographischer Informationen, wodurch eine automatisierte einheitliche Formatierung sämtlicher Quellenverweise innerhalb des Living Handbooks sichergestellt wird. Entsprechend formatierte Quellenverweise können heute auf den Seiten der meisten Verlage und Repositorien im "Cite As"-Menu direkt heruntergeladen werden. Außerdem können bibtex-formatierte Quellenangaben für DOIs direkt von den beiden größten DOI-vergebenden Organisationen Crossref (für Artikel und Bücher) und Datacite (für Datenpublikationen, Software und weitere Medien) abgerufen werden:

Zusätzlich existieren Webservices, über die beispielsweise die bibtex-formatierten Quellenangaben für Webseiten und andere Medien erstellt werden können, beispielweise https://www.bibme.org/bibtex/website-citation.

Zitate im Text müssen so angegeben werden, dass sie leicht den entsprechenden Einträgen im Quellenverzeichnis zugeordnet werden können. Falls möglich, werde Zitate in der Form [@KEY] angegeben, wobei KEY für eine beliebige Zeichenfolge steht, die das Zitat eindeutig einem Eintrag im Quellenverzeichnis zuordnet (z. B. die DOI, "Musterfrau_et_al2022"; in bibtex-formatierten Quellenangaben entspricht KEY dem Inhalt der ersten Zeile nach {). Mehrere Zitate werden durch ein Semikolon getrennt: [@Müller2020; @Schneider2022].

Sofern vorhanden, sollten zusätzliche Literatur, Webseiten und andere Materialien in einem Kapitel "Weiterführende Information" aufgelistet werden um den Lesenden einen tieferen Einstieg in das Thema zu erleichtern.

Collections

Collections bündeln thematisch ähnliche Artikel. Eine Collection ist formal ein Artikel mit einer kurzen Einführung in das Thema gefolgt von einer Linkliste aller ihr zugeordneten Artikel. Durch das Vorschlagen geeigneter Collections für einen Artikel kann dieser leicht in die Struktur des Living Handbook eingebettet werden. Ausführlichere Informationen über Collections werden im entsprechenden Artikel bereitgestellt.

Interaktive Inhalte

Das NFDI4Earth Living Handbook unterstützt prinzipiell sämtliche Typen elektronischer Medien, inklusiver interaktiver Elemente. Die Implementierung solcher Elemente erfolgt anlassbezogen. Es wird daher darum gebeten, mit dem Editorial Board via Email an nfdi4earth-livinghandbook@tu-dresden.de rechtzeitig Kontakt aufzunehmen, falls interaktive Elemente im Artikel vorgesehen sind.

Autorenvereinbarung und Lizenzen

Beiträge zum Living Handbook bedingen das Unterschreiben der Autorenvereinbarung. Sobald ein Artikel eingereicht wird, wird der Managing Editor Sie darum bitten, in dem er sie zur Abonnierung der Mailingliste nfdi4earth-lhb-contributors@groups.tu-dresden.de einlädt (wir nutzen diesen Mechanismus als einfache DSGVO-konforme Lösung zur Speicherung Ihrer Daten). Die Annahme der Einladung bzw. Eintragung auf der Mailingliste ist gleichbedeutend mit der Annahme der Autorenvereinbarung. Über diese Mailingliste werden keine Emails verschickt, außer unmittelbar die Autorenvereinbarung betreffende Entwicklungen. Sie können die Autorenvereinbarung auch proaktiv unterschreiben, indem Sie sich selbst auf die Mailinglist eintragen.

Die Artikel und sämtliche nicht aus anderen Quellen übernommenen Inhalte (z. B. Bilder) müssen unter der Lizenz CC-BY 4.0 veröffentlicht werden.

Für aus externen Quellen eingebettete Elemente müssen in ihrer (Bild)unterschrift deren Quellen gemäß den Richtlinien ihrer jeweiligen Lizenz zitiert werden. In jedem Fall beinhaltet der Verweis auf das Original den Urheber, einen Link zur entsprechenden Webseite, den Namen der Lizenz unter der die Inhalte des Elementes veröffentlicht wurden sowie ein Link zum Text dieser Lizenz.

Die den Artikel verfassenden Personen versichern, dass sämtliche für den Artikel verwendeten Materialien inklusiver eventueller nachgenutzter externer Inhalte für eine Veröffentlichung unter CC-BY 4.0 freigegeben sind. Die den Artikel verfassenden Personen versichern außerdem, dass sämtliche Quellen in angemessener Form angegeben wurden und jegliche wörtlich übernommenen Teile als wörtliche Zitate markiert wurden.

Barrierefreiheit

Um die Artikel so barrierefrei wie möglich zu machen, sollte Folgendes berücksichtigt werden:

  • Bereitstellung von Beschreibungen für alle nicht auf text basierenden Elemente, insbesondere Bilder und Diagramme.
  • Nutzung farbenblid-freundlicher Farbschemata. Siehe z. B. https://davidmathlogic.com/colorblind für grundlegende Informationen zur Erstellung farbenblind-freundlicher Abbildungen und https://www.color-blindness.com/coblis-color-blindness-simulator/ um zu überprüfen, wie Ihre Abbildung bei verschiedenen Typen von Farbenblindheit aussieht.
  • Sicherstellung eines hohen Kontrast in grafischen Elementen
  • Klare und kohärente Struktur der Artikel

Es gibt zahlreiche Internetseiten mit Informationen zur Erstellung barrierefreier Artikel für Webseiten. Einen guten Einstieg bietet die entsprechende Seite des W3C.

Inklusive Sprache

Die Leserschaft des Living Handbook ist sehr divers. Dementsprechend inklusiv sollen die Artikel geschrieben sein. Es gibt zahlreiche Webseiten zur Nutzung inklusiver, insbesondere geschlechter-neutraler Sprache. Einen guten Einsteig inklusive Leitfaden stellt die Universität Konstanz auf ihrer Internetseite zur Verfügung. Außerdem bietet beispielsweise der Leitfaden von Amnesty International zur inklusiven Sprache einen guten Überblick für inklusive deutsche Sprache. Als englischsprachige Ressourcen seien hier beispielhaft "Promoting inclusive inLanguage: an incomplete guide (v2)" der EGU als kurzen und kompakten Einstieg in das Thema sowie die "Specific guidelines for English" in den "Gender-Neutral Language Guidelines" des Europäischen Parlaments mit zahlreichen konkreten Beispielen erwähnt.

Technische Spezifikation

Artikel sollten idealerweise im Markdown-Format (.md) eingereicht werden. Alternativ können sie als unformatierte Textdatei (.txt) oder formatierten Text (.doc, .docx) eingereicht werden. In formatierten Texten sollten Formatierungen im Text auf das absolute Minimum beschränkt werden. Sämtliche Abbildungen und weitere Medien müssen in jedem Fall als separate Datei eingereicht werden. Bitten wenden Sie sich an das Editorial Board via nfdi4earth-livinghandbook@tu-dresden.de, falls Sie Hilfe bei der Vorbereitung Ihres Artikel benötigen.

Nicht-text-Dateien sollten in den folgenden Formaten eingereicht werden:

Typ Dateiformat
Rastergrafik .png
Vektorgrafik .svg
Diagramme, Flowcharts, ... .svg oder als mermaid code innerhalb des Artikels.

Weiterführende Information