mirror of
https://scm.cms.hu-berlin.de/methodenlabor/doc_documentation.git
synced 2025-08-22 11:53:16 +02:00
Compare commits
7 Commits
c72a3f255c
...
main
Author | SHA1 | Date | |
---|---|---|---|
6d7f7f3dfa | |||
1dd2310caa | |||
dac7b3f039 | |||
6202af618a | |||
19ca830585 | |||
b4a0e4dc5e | |||
8dd32b411b |
62
README.md
62
README.md
@ -1,7 +1,30 @@
|
|||||||
# Good™ Documentation
|
---
|
||||||
|
title: Good™ Documentation
|
||||||
Dieses Repository enthält eine Beispielstruktur, nach welchen Regeln und in
|
description: |
|
||||||
welcher Ausführlichkeit sinnvoll dokumentiert werden sollte.
|
Dieses Repository enthält eine Beispielstruktur, nach welchen Regeln und in welcher Ausführlichkeit sinnvoll dokumentiert werden sollte.
|
||||||
|
lang: de
|
||||||
|
date: 2025-06-03
|
||||||
|
authors:
|
||||||
|
- name: Nicole Dresselhaus
|
||||||
|
affiliation:
|
||||||
|
- name: Humboldt-Universität zu Berlin
|
||||||
|
url: https://hu-berlin.de
|
||||||
|
email: nicole.dresselhaus@hu-berlin.de
|
||||||
|
correspondence: true
|
||||||
|
orcid: 0009-0008-8850-3679
|
||||||
|
roles:
|
||||||
|
- Conceptualization
|
||||||
|
- "Writing – first draft"
|
||||||
|
- "Writing – review & editing"
|
||||||
|
- name: Till Grallert
|
||||||
|
affiliation:
|
||||||
|
- name: Humboldt-Universität zu Berlin
|
||||||
|
url: https://hu-berlin.de
|
||||||
|
email: till.grallert@hu-berlin.de
|
||||||
|
roles:
|
||||||
|
- Supervision
|
||||||
|
- Validation
|
||||||
|
---
|
||||||
|
|
||||||
## Ziel / Zweck
|
## Ziel / Zweck
|
||||||
|
|
||||||
@ -37,33 +60,22 @@ um ein Applikationsprojekt im klassischen Sinne handelt.
|
|||||||
Ziel ist hier die Entwicklung und langfristig die Installation,
|
Ziel ist hier die Entwicklung und langfristig die Installation,
|
||||||
Veröffentlichung,Nutzung und Wartung der Software.
|
Veröffentlichung,Nutzung und Wartung der Software.
|
||||||
|
|
||||||
Das Template enthält folgende Struktur:
|
Zur genauer Struktur und Handhabung sei auf die `README.md` dort verwiesen.
|
||||||
|
|
||||||
```plain
|
|
||||||
.
|
|
||||||
├── .gitlab (issue-templates für GitLab)
|
|
||||||
├── CHANGELOG.md (CHANGELOG-Beispiel für Releases)
|
|
||||||
├── CITATION.md (Wie die Software zitieren?)
|
|
||||||
├── CONTRIBUTING.md (Wie bei der Software mithelfen?)
|
|
||||||
├── INSTALL.md (Wie die Software installieren?)
|
|
||||||
├── README.md (Genereller Überblick)
|
|
||||||
├── src (Beispielverzeichnis für den eigentlichen Code)
|
|
||||||
└── USAGE.md (Wie nutze ich die Software?)
|
|
||||||
```
|
|
||||||
|
|
||||||
Die Dateien enthalten jeweils eine Anleitung über ihren Inhalt
|
|
||||||
|
|
||||||
### Daten-Project
|
### Daten-Project
|
||||||
|
|
||||||
**Ein ähnliches Projekt für Daten-Repositories ist in Planung.**
|
Analog zum Code-Project ist das
|
||||||
|
[Daten-Project-Template](https://scm.cms.hu-berlin.de/methodenlabor/templates/data-project-template)
|
||||||
Das Template ist für Repositories gedacht, die Daten aus Quellen erstellen,
|
für Repositories gedacht, die irgendeine Art von Daten als Output haben. Hierbei
|
||||||
aufbereiten und wieder zur Verfügung stellen. Beispiele wären z.b. Bilder ~>
|
geht es um die reine Vorverarbeitung der Daten und nicht um Analyse.
|
||||||
annotierter Korpus.
|
Typischerweise liegen hier z.b. Roh-Daten (Bilder, etc.) vor und der Output ist
|
||||||
|
ein Maschinenlesbares Format (z.b. JSON des Textes mit Annotationen).
|
||||||
|
|
||||||
Ziel ist hier die Dokumentation und die Reproduzierbarkeit von
|
Ziel ist hier die Dokumentation und die Reproduzierbarkeit von
|
||||||
`Quelle -> Datensatz`.
|
`Quelle -> Datensatz`.
|
||||||
|
|
||||||
|
Zur genauer Struktur und Handhabung sei auf die `README.md` dort verwiesen.
|
||||||
|
|
||||||
## Wissenschaftlicher Hintergrund
|
## Wissenschaftlicher Hintergrund
|
||||||
|
|
||||||
Dieses gesamte Repository wurde erstellt um Forschenden eine fundierte,
|
Dieses gesamte Repository wurde erstellt um Forschenden eine fundierte,
|
||||||
@ -74,7 +86,7 @@ dokumentieren. Insbesondere hervorzuheben sind hier die
|
|||||||
[Ten simple rules for documenting scientific software](https://doi.org/10.1371/journal.pcbi.1006561).
|
[Ten simple rules for documenting scientific software](https://doi.org/10.1371/journal.pcbi.1006561).
|
||||||
|
|
||||||
Für eine Ausführliche auseinandersetzung mit dieser Thematik siehe
|
Für eine Ausführliche auseinandersetzung mit dieser Thematik siehe
|
||||||
`BACKGROUND.md`
|
[BACKGROUND.md](background/BACKGROUND.md)
|
||||||
|
|
||||||
## Bekannte Einschränkungen
|
## Bekannte Einschränkungen
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
@ -1,6 +1,3 @@
|
|||||||
% this bibliography is maintained in Zotero with the tag 'project: documentation'
|
|
||||||
% prefered format is BibLaTeX
|
|
||||||
|
|
||||||
@book{AhnertEtAl2023CollaborativeHistoricalResearch,
|
@book{AhnertEtAl2023CollaborativeHistoricalResearch,
|
||||||
title = {Collaborative {{Historical Research}} in the {{Age}} of {{Big Data}}: {{Lessons}} from an {{Interdisciplinary Project}}},
|
title = {Collaborative {{Historical Research}} in the {{Age}} of {{Big Data}}: {{Lessons}} from an {{Interdisciplinary Project}}},
|
||||||
shorttitle = {Collaborative {{Historical Research}} in the {{Age}} of {{Big Data}}},
|
shorttitle = {Collaborative {{Historical Research}} in the {{Age}} of {{Big Data}}},
|
||||||
@ -14,8 +11,12 @@
|
|||||||
urldate = {2023-01-26},
|
urldate = {2023-01-26},
|
||||||
abstract = {This book is output of the Living with Machines project},
|
abstract = {This book is output of the Living with Machines project},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {field: History,project: documentation,Project: Methods Lab 🥼}
|
language = {en},
|
||||||
|
keywords = {field: History,project: documentation,Project: Methods Lab 🥼},
|
||||||
|
file = {/home/drezil/Zotero/storage/ET5S8DMH/Ahnert et al. - 2023 - Collaborative Historical Research in the Age of Big Data Lessons from an Interdisciplinary Project.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for AhnertEtAl2023CollaborativeHistoricalResearch:
|
||||||
|
% ? Title looks like it was stored in title-case in Zotero
|
||||||
|
|
||||||
@report{AltenhonerEtAl2023DFGPraxisregeln,
|
@report{AltenhonerEtAl2023DFGPraxisregeln,
|
||||||
title = {DFG-Praxisregeln "Digitalisierung". Aktualisierte Fassung 2022.},
|
title = {DFG-Praxisregeln "Digitalisierung". Aktualisierte Fassung 2022.},
|
||||||
@ -25,8 +26,15 @@
|
|||||||
urldate = {2023-03-07},
|
urldate = {2023-03-07},
|
||||||
abstract = {Die DFG-Praxisregeln „Digitalisierung“ stellen eine zentrale Grundlage für DFG-geförderte Projekte im Programm „Digitalisierung und Erschließung“ dar: Sie formulieren Standards und enthalten Informationen zu organisatorischen, methodischen und technischen Fragen im Kontext der Digitalisierung und Erschließung forschungsrelevanter Objekte. Sie leisten damit einen wichtigen Beitrag zur Nachhaltigkeit, Zugänglichkeit und Anschlussfähigkeit geförderter Projekte und der in diesem Zusammenhang entstehenden Infrastruktur. Das vorliegende Dokument stellt eine aktualisierte Fassung der zuletzt 2016 durch die DFG publizierten Praxisregeln dar. Es wurde in Absprache mit der DFG-Geschäftsstelle durch eine vom NFDI-Konsortium NFDI4Culture initiierte Autor*innengruppe erarbeitet, deren Mitglieder mehrheitlich seit langem an der Ausgestaltung der Praxisregeln beteiligt waren sowie aktiv in die NFDI-Konsortien NFDI4Culture, NFDI4Memory, NFDI4Objects und Text+ eingebunden sind. Die jetzt überarbeitet vorliegenden Praxisregeln „Digitalisierung“ dienen als Ausgangspunkt für eine material- und communitybezogene Ausdifferenzierung der Praxisregeln durch die Communitys. Alle mit der Digitalisierung forschungsrelevanter Objekte befassten Communitys und Einrichtungen sind dazu aufgerufen, mit ihrer Expertise am weiteren Prozess mitzuwirken.},
|
abstract = {Die DFG-Praxisregeln „Digitalisierung“ stellen eine zentrale Grundlage für DFG-geförderte Projekte im Programm „Digitalisierung und Erschließung“ dar: Sie formulieren Standards und enthalten Informationen zu organisatorischen, methodischen und technischen Fragen im Kontext der Digitalisierung und Erschließung forschungsrelevanter Objekte. Sie leisten damit einen wichtigen Beitrag zur Nachhaltigkeit, Zugänglichkeit und Anschlussfähigkeit geförderter Projekte und der in diesem Zusammenhang entstehenden Infrastruktur. Das vorliegende Dokument stellt eine aktualisierte Fassung der zuletzt 2016 durch die DFG publizierten Praxisregeln dar. Es wurde in Absprache mit der DFG-Geschäftsstelle durch eine vom NFDI-Konsortium NFDI4Culture initiierte Autor*innengruppe erarbeitet, deren Mitglieder mehrheitlich seit langem an der Ausgestaltung der Praxisregeln beteiligt waren sowie aktiv in die NFDI-Konsortien NFDI4Culture, NFDI4Memory, NFDI4Objects und Text+ eingebunden sind. Die jetzt überarbeitet vorliegenden Praxisregeln „Digitalisierung“ dienen als Ausgangspunkt für eine material- und communitybezogene Ausdifferenzierung der Praxisregeln durch die Communitys. Alle mit der Digitalisierung forschungsrelevanter Objekte befassten Communitys und Einrichtungen sind dazu aufgerufen, mit ihrer Expertise am weiteren Prozess mitzuwirken.},
|
||||||
langid = {deu},
|
langid = {deu},
|
||||||
keywords = {Digital Scholarly Editions,project: documentation,Project: Methods Lab 🥼,TEI: Text Encoding Initiative}
|
language = {deu},
|
||||||
|
keywords = {Digital Scholarly Editions,Digitalisierung,Erschließung,Informationsinfrastrukturen,NFDI,Praxisregeln,project: documentation,Project: Methods Lab 🥼,Standardbildung,TEI: Text Encoding Initiative},
|
||||||
|
file = {/home/drezil/Zotero/storage/46FYRPPH/Altenhöner et al. - 2023 - DFG-Praxisregeln Digitalisierung. Aktualisierte Fassung 2022..pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for AltenhonerEtAl2023DFGPraxisregeln:
|
||||||
|
% Missing required field 'type'
|
||||||
|
% Missing required field 'institution'
|
||||||
|
% ? Title looks like it was stored in title-case in Zotero
|
||||||
|
% ? unused Library catalog ("Zenodo")
|
||||||
|
|
||||||
@article{BarkerEtAl2022IntroducingFAIR,
|
@article{BarkerEtAl2022IntroducingFAIR,
|
||||||
title = {Introducing the {{FAIR Principles}} for Research Software},
|
title = {Introducing the {{FAIR Principles}} for Research Software},
|
||||||
@ -44,8 +52,13 @@
|
|||||||
urldate = {2024-09-10},
|
urldate = {2024-09-10},
|
||||||
abstract = {Research software is a fundamental and vital part of research, yet significant challenges to discoverability, productivity, quality, reproducibility, and sustainability exist. Improving the practice of scholarship is a common goal of the open science, open source, and FAIR (Findable, Accessible, Interoperable and Reusable) communities and research software is now being understood as a type of digital object to which FAIR should be applied. This emergence reflects a maturation of the research community to better understand the crucial role of FAIR research software in maximising research value. The FAIR for Research Software (FAIR4RS) Working Group has adapted the FAIR Guiding Principles to create the FAIR Principles for Research Software (FAIR4RS Principles). The contents and context of the FAIR4RS Principles are summarised here to provide the basis for discussion of their adoption. Examples of implementation by organisations are provided to share information on how to maximise the value of research outputs, and to encourage others to amplify the importance and impact of this work.},
|
abstract = {Research software is a fundamental and vital part of research, yet significant challenges to discoverability, productivity, quality, reproducibility, and sustainability exist. Improving the practice of scholarship is a common goal of the open science, open source, and FAIR (Findable, Accessible, Interoperable and Reusable) communities and research software is now being understood as a type of digital object to which FAIR should be applied. This emergence reflects a maturation of the research community to better understand the crucial role of FAIR research software in maximising research value. The FAIR for Research Software (FAIR4RS) Working Group has adapted the FAIR Guiding Principles to create the FAIR Principles for Research Software (FAIR4RS Principles). The contents and context of the FAIR4RS Principles are summarised here to provide the basis for discussion of their adoption. Examples of implementation by organisations are provided to share information on how to maximise the value of research outputs, and to encourage others to amplify the importance and impact of this work.},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼,RSE: Research Software Engineering}
|
language = {en},
|
||||||
|
keywords = {Policy,project: documentation,Project: Methods Lab 🥼,Research management,RSE: Research Software Engineering},
|
||||||
|
file = {/home/drezil/Zotero/storage/VRFPNWKW/VRFPNWKW_Barker et al. - 2022 - Introducing the FAIR Principles for research software.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for BarkerEtAl2022IntroducingFAIR:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? unused Library catalog ("www.nature.com")
|
||||||
|
|
||||||
@book{CremerEtAl2024Projektmanagement,
|
@book{CremerEtAl2024Projektmanagement,
|
||||||
title = {Projektmanagement und Digital Humanities: Zur klugen Gestaltung der Zusammenarbeit},
|
title = {Projektmanagement und Digital Humanities: Zur klugen Gestaltung der Zusammenarbeit},
|
||||||
@ -56,10 +69,14 @@
|
|||||||
doi = {10.14361/9783839469675},
|
doi = {10.14361/9783839469675},
|
||||||
abstract = {Die Professionalisierung des Projektmanagements in den Digital Humanities: Theorie und Praxis zum Weiterdenken.},
|
abstract = {Die Professionalisierung des Projektmanagements in den Digital Humanities: Theorie und Praxis zum Weiterdenken.},
|
||||||
langid = {ngerman},
|
langid = {ngerman},
|
||||||
keywords = {field: Digital Humanities (DH),Project management,project: documentation,Project: Methods Lab 🥼}
|
language = {de},
|
||||||
|
keywords = {field: Digital Humanities (DH),Project management,project: documentation,Project: Methods Lab 🥼},
|
||||||
|
file = {/home/drezil/Zotero/storage/GYJK3NUY/Cremer et al. - 2024 - Projektmanagement und Digital Humanities Zur klugen Gestaltung der Zusammenarbeit.pdf;/home/drezil/Zotero/storage/XQ6AI49P/Cremer et al. - 2024 - Projektmanagement und Digital Humanities Zur klugen Gestaltung der Zusammenarbeit.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for CremerEtAl2024Projektmanagement:
|
||||||
|
% Missing required field 'author'
|
||||||
|
|
||||||
@article{DiehlEtAl2025JournalOpenSource,
|
@article{Diehl2025JournalOpenSource,
|
||||||
title = {The {{Journal}} of {{Open Source Software}} ({{JOSS}}): {{Bringing Open-Source Software Practices}} to the {{Scholarly Publishing Community}} for {{Authors}}, {{Reviewers}}, {{Editors}}, and {{Publishers}}},
|
title = {The {{Journal}} of {{Open Source Software}} ({{JOSS}}): {{Bringing Open-Source Software Practices}} to the {{Scholarly Publishing Community}} for {{Authors}}, {{Reviewers}}, {{Editors}}, and {{Publishers}}},
|
||||||
shorttitle = {The {{Journal}} of {{Open Source Software}} ({{JOSS}})},
|
shorttitle = {The {{Journal}} of {{Open Source Software}} ({{JOSS}})},
|
||||||
author = {Diehl, Patrick and Soneson, Charlotte and Kurchin, Rachel C. and Mounce, Ross and Katz, Daniel S.},
|
author = {Diehl, Patrick and Soneson, Charlotte and Kurchin, Rachel C. and Mounce, Ross and Katz, Daniel S.},
|
||||||
@ -75,8 +92,14 @@
|
|||||||
abstract = {Introduction: Open-source software (OSS) is a critical component of open science, but contributions to the OSS ecosystem are systematically undervalued in the current academic system. The Journal of Open Source Software (JOSS) contributes to addressing this by providing a venue (that is itself free, diamond open access, and all open-source, built in a layered structure using widely available elements/services of the scholarly publishing ecosystem) for publishing OSS, run in the style of OSS itself. A particularly distinctive element of JOSS is that it uses open peer review in a collaborative, iterative format, unlike most publishers. Additionally, all the components of the process—from the reviews to the papers to the software that is the subject of the papers to the software that the journal runs—are open. Background: We describe JOSS’s history and its peer review process using an editorial bot, and we present statistics gathered from JOSS’s public review history on GitHub showing an increasing number of peer reviewed papers each year. We discuss the new JOSSCast and use it as a data source to understand reasons why interviewed authors decided to publish in JOSS. Discussion and Outlook: JOSS’s process differs significantly from traditional journals, which has impeded JOSS’s inclusion in indexing services such as Web of Science. In turn, this discourages researchers within certain academic systems, such as Italy’s, which emphasize the importance of Web of Science and/or Scopus indexing for grant applications and promotions. JOSS is a fully diamond open-access journal with a cost of around US\$5 per paper for the 401 papers published in 2023. The scalability of running JOSS with volunteers and financing JOSS with grants and donations is discussed.},
|
abstract = {Introduction: Open-source software (OSS) is a critical component of open science, but contributions to the OSS ecosystem are systematically undervalued in the current academic system. The Journal of Open Source Software (JOSS) contributes to addressing this by providing a venue (that is itself free, diamond open access, and all open-source, built in a layered structure using widely available elements/services of the scholarly publishing ecosystem) for publishing OSS, run in the style of OSS itself. A particularly distinctive element of JOSS is that it uses open peer review in a collaborative, iterative format, unlike most publishers. Additionally, all the components of the process—from the reviews to the papers to the software that is the subject of the papers to the software that the journal runs—are open. Background: We describe JOSS’s history and its peer review process using an editorial bot, and we present statistics gathered from JOSS’s public review history on GitHub showing an increasing number of peer reviewed papers each year. We discuss the new JOSSCast and use it as a data source to understand reasons why interviewed authors decided to publish in JOSS. Discussion and Outlook: JOSS’s process differs significantly from traditional journals, which has impeded JOSS’s inclusion in indexing services such as Web of Science. In turn, this discourages researchers within certain academic systems, such as Italy’s, which emphasize the importance of Web of Science and/or Scopus indexing for grant applications and promotions. JOSS is a fully diamond open-access journal with a cost of around US\$5 per paper for the 401 papers published in 2023. The scalability of running JOSS with volunteers and financing JOSS with grants and donations is discussed.},
|
||||||
issue = {2},
|
issue = {2},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
language = {eng},
|
||||||
|
keywords = {project: documentation,Project: Methods Lab 🥼},
|
||||||
|
file = {/home/drezil/Zotero/storage/G4T6JNUU/Diehl et al. - 2025 - The Journal of Open Source Software (JOSS) Bringing Open-Source Software Practices to the Scholarly.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Diehl2025JournalOpenSource:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? Title looks like it was stored in title-case in Zotero
|
||||||
|
% ? unused Library catalog ("www.iastatedigitalpress.com")
|
||||||
|
|
||||||
@misc{EndingsPrinciples221,
|
@misc{EndingsPrinciples221,
|
||||||
title = {Endings {{Principles}} for {{Digital Longevity}}},
|
title = {Endings {{Principles}} for {{Digital Longevity}}},
|
||||||
@ -87,9 +110,12 @@
|
|||||||
urldate = {2024-05-14},
|
urldate = {2024-05-14},
|
||||||
abstract = {Enabling Sustainable Digital Humanities Projects},
|
abstract = {Enabling Sustainable Digital Humanities Projects},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
|
language = {en},
|
||||||
version = {2.2.1},
|
version = {2.2.1},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼,Project: Tool Registry 🧰,talk: 2024 Bochum,writing: 2024 Tool Registry}
|
keywords = {project: documentation,Project: Methods Lab 🥼,Project: Tool Registry 🧰,talk: 2024 Bochum,writing: 2024 Tool Registry}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for EndingsPrinciples221:
|
||||||
|
% ? Title looks like it was stored in title-case in Zotero
|
||||||
|
|
||||||
@standard{Forschungsgemeinschaft2025LeitlinienzurSicherung,
|
@standard{Forschungsgemeinschaft2025LeitlinienzurSicherung,
|
||||||
title = {Leitlinien zur Sicherung guter wissenschaftlicher Praxis},
|
title = {Leitlinien zur Sicherung guter wissenschaftlicher Praxis},
|
||||||
@ -100,27 +126,60 @@
|
|||||||
urldate = {2025-05-15},
|
urldate = {2025-05-15},
|
||||||
abstract = {The DFG´s Code of Conduct “Safeguarding Good Research Practice” represents the consensus among the member organisations of the DFG on the fundamental principles and standards of good practice and are upheld by these organisations. These guidelines underline the importance of integrity in the everyday practice of research and provide researchers with a reliable reference with which to embed good research practice as an established and binding aspect of their work.},
|
abstract = {The DFG´s Code of Conduct “Safeguarding Good Research Practice” represents the consensus among the member organisations of the DFG on the fundamental principles and standards of good practice and are upheld by these organisations. These guidelines underline the importance of integrity in the everyday practice of research and provide researchers with a reliable reference with which to embed good research practice as an established and binding aspect of their work.},
|
||||||
langid = {ngerman},
|
langid = {ngerman},
|
||||||
|
language = {de},
|
||||||
version = {1.2},
|
version = {1.2},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
keywords = {code of conduct,Deutsche Forschungsgemeinschaft,DFG,German research foundation,good scientific practice,gute wissenschaftliche Praxis,Kodex,Leitlinien zur Sicherung guter wissenschaftlicher Praxis,project: documentation,Project: Methods Lab 🥼,research integrity,scientific misconduct,Wissenschaftliche Integrität,wissenschaftliches Fehlverhalten},
|
||||||
|
file = {/home/drezil/Zotero/storage/DMF478TJ/2024 - Leitlinien zur Sicherung guter wissenschaftlicher Praxis.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Forschungsgemeinschaft2025LeitlinienzurSicherung:
|
||||||
|
% Unexpected field 'title'
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% Unexpected field 'language'
|
||||||
|
% Unexpected field 'version'
|
||||||
|
% ? unused Committee ("Team „Wissenschaftliche Integrität“")
|
||||||
|
% ? unused Library catalog ("Zenodo")
|
||||||
|
|
||||||
@book{Kemman2021Trading,
|
@article{Hasselbring2020OpenSourceResearch,
|
||||||
title = {Trading {{Zones}} of {{Digital History}}},
|
title = {Open {{Source Research Software}}},
|
||||||
author = {Kemman, Max},
|
author = {Hasselbring, Wilhelm and Carr, Leslie and Hettrick, Simon and Packer, Heather and Tiropanis, Thanassis},
|
||||||
date = {2021},
|
date = {2020-08},
|
||||||
series = {Studies in {{Digital History}} and {{Hermeneutics}}},
|
journaltitle = {Computer},
|
||||||
number = {1},
|
shortjournal = {Computer},
|
||||||
publisher = {De Gruyter Oldenbourg},
|
volume = {53},
|
||||||
location = {Berlin, Boston},
|
number = {8},
|
||||||
doi = {10.1515/9783110682106},
|
pages = {84--88},
|
||||||
url = {https://www.degruyter.com/document/doi/10.1515/9783110682106/html},
|
issn = {0018-9162, 1558-0814},
|
||||||
urldate = {2021-09-23},
|
doi = {10.1109/MC.2020.2998235},
|
||||||
abstract = {Digital history is commonly argued to be positioned between the traditionally historical and the computational or digital. By studying digital history collaborations and the establishment of the Luxembourg Centre for Contemporary and Digital History, Kemman examines how digital history will impact historical scholarship. His analysis shows that digital history does not occupy a singular position between the digital and the historical. Instead, historians continuously move across this dimension, choosing or finding themselves in different positions as they construct different trading zones through cross-disciplinary engagement, negotiation of research goals and individual interests.},
|
url = {https://ieeexplore.ieee.org/document/9153295/},
|
||||||
isbn = {978-3-11-068210-6},
|
urldate = {2025-06-05},
|
||||||
langid = {english},
|
keywords = {Praxisregeln,project: documentation,Project: Methods Lab 🥼,Research Software Engineering,Standardbildung},
|
||||||
pagetotal = {182},
|
file = {/home/drezil/Zotero/storage/E8CWCEFF/Hasselbring et al. - 2020 - Open Source Research Software.pdf}
|
||||||
keywords = {Digital History,Eintrag bereinigt,PDF (Dropbox),project: documentation,TH-MA-Bloomsbury}
|
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Hasselbring2020OpenSourceResearch:
|
||||||
|
% 'issn': not a valid ISSN
|
||||||
|
% ? Title looks like it was stored in title-case in Zotero
|
||||||
|
% ? unused Library catalog ("DOI.org (Crossref)")
|
||||||
|
|
||||||
|
@article{JimenezEtAl2017FourSimpleRecommendations,
|
||||||
|
title = {Four Simple Recommendations to Encourage Best Practices in Research Software},
|
||||||
|
author = {Jiménez, Rafael C. and Kuzak, Mateusz and Alhamdoosh, Monther and Barker, Michelle and Batut, Bérénice and Borg, Mikael and Capella-Gutierrez, Salvador and Chue Hong, Neil and Cook, Martin and Corpas, Manuel and Flannery, Madison and Garcia, Leyla and Gelpí, Josep Ll. and Gladman, Simon and Goble, Carole and González Ferreiro, Montserrat and Gonzalez-Beltran, Alejandra and Griffin, Philippa C. and Grüning, Björn and Hagberg, Jonas and Holub, Petr and Hooft, Rob and Ison, Jon and Katz, Daniel S. and Leskošek, Brane and López Gómez, Federico and Oliveira, Luis J. and Mellor, David and Mosbergen, Rowland and Mulder, Nicola and Perez-Riverol, Yasset and Pergl, Robert and Pichler, Horst and Pope, Bernard and Sanz, Ferran and Schneider, Maria V. and Stodden, Victoria and Suchecki, Radosław and Svobodová Vařeková, Radka and Talvik, Harry-Anton and Todorov, Ilian and Treloar, Andrew and Tyagi, Sonika and Van Gompel, Maarten and Vaughan, Daniel and Via, Allegra and Wang, Xiaochuan and Watson-Haigh, Nathan S. and Crouch, Steve},
|
||||||
|
date = {2017-06-13},
|
||||||
|
journaltitle = {F1000Research},
|
||||||
|
shortjournal = {F1000Res},
|
||||||
|
volume = {6},
|
||||||
|
pages = {876},
|
||||||
|
issn = {2046-1402},
|
||||||
|
doi = {10.12688/f1000research.11407.1},
|
||||||
|
url = {https://f1000research.com/articles/6-876/v1},
|
||||||
|
urldate = {2025-06-05},
|
||||||
|
abstract = {Scientific research relies on computer software, yet software is not always developed following practices that ensure its quality and sustainability. This manuscript does not aim to propose new software development best practices, but rather to provide simple recommendations that encourage the adoption of existing best practices. Software development best practices promote better quality software, and better quality software improves the reproducibility and reusability of research. These recommendations are designed around Open Source values, and provide practical suggestions that contribute to making research software and its source code more discoverable, reusable and transparent. This manuscript is aimed at developers, but also at organisations, projects, journals and funders that can increase the quality and sustainability of research software by encouraging the adoption of these recommendations.},
|
||||||
|
langid = {english},
|
||||||
|
language = {en},
|
||||||
|
keywords = {Praxisregeln,project: documentation,Project: Methods Lab 🥼,Research Software Engineering},
|
||||||
|
file = {/home/drezil/Zotero/storage/86E3F4DV/Jiménez et al. - 2017 - Four simple recommendations to encourage best practices in research software.pdf}
|
||||||
|
}
|
||||||
|
% == BibLateX quality report for JimenezEtAl2017FourSimpleRecommendations:
|
||||||
|
% ? unused Library catalog ("DOI.org (Crossref)")
|
||||||
|
|
||||||
@inproceedings{KluyverEtAl2016JupyterNotebookspublishing,
|
@inproceedings{KluyverEtAl2016JupyterNotebookspublishing,
|
||||||
title = {Jupyter {{Notebooks}} – a Publishing Format for Reproducible Computational Workflows},
|
title = {Jupyter {{Notebooks}} – a Publishing Format for Reproducible Computational Workflows},
|
||||||
@ -137,10 +196,15 @@
|
|||||||
abstract = {It is increasingly necessary for researchers in all fields to write computer code, and in order to reproduce research results, it is important that this code is published. We present Jupyter notebooks, a document format for publishing code, results and explanations in a form that is both readable and executable. We discuss various tools and use cases for notebook documents.},
|
abstract = {It is increasingly necessary for researchers in all fields to write computer code, and in order to reproduce research results, it is important that this code is published. We present Jupyter notebooks, a document format for publishing code, results and explanations in a form that is both readable and executable. We discuss various tools and use cases for notebook documents.},
|
||||||
eventtitle = {20th {{International Conference}} on {{Electronic Publishing}} (01/01/16)},
|
eventtitle = {20th {{International Conference}} on {{Electronic Publishing}} (01/01/16)},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
language = {en},
|
||||||
|
keywords = {project: documentation,Project: Methods Lab 🥼},
|
||||||
|
file = {/home/drezil/Zotero/storage/QB33NJLA/Kluyver et al. - 2016 - Jupyter Notebooks – a publishing format for reproducible computational workflows.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for KluyverEtAl2016JupyterNotebookspublishing:
|
||||||
|
% Missing required field 'booktitle'
|
||||||
|
% ? unused Library catalog ("eprints.soton.ac.uk")
|
||||||
|
|
||||||
@article{lamprecht2020towards,
|
@article{Lamprecht2020TowardsFAIRPrinciples,
|
||||||
title = {Towards {{FAIR}} Principles for~Research~Software},
|
title = {Towards {{FAIR}} Principles for~Research~Software},
|
||||||
author = {Lamprecht, Anna-Lena and Garcia, Leyla and Kuzak, Mateusz and Martinez, Carlos and Arcila, Ricardo and Martin Del Pico, Eva and Dominguez Del Angel, Victoria and family=Sandt, given=Stephanie, prefix=van de, useprefix=true and Ison, Jon and Martinez, Paula Andrea and McQuilton, Peter and Valencia, Alfonso and Harrow, Jennifer and Psomopoulos, Fotis and Gelpi, Josep Ll. and Chue Hong, Neil and Goble, Carole and Capella-Gutierrez, Salvador},
|
author = {Lamprecht, Anna-Lena and Garcia, Leyla and Kuzak, Mateusz and Martinez, Carlos and Arcila, Ricardo and Martin Del Pico, Eva and Dominguez Del Angel, Victoria and family=Sandt, given=Stephanie, prefix=van de, useprefix=true and Ison, Jon and Martinez, Paula Andrea and McQuilton, Peter and Valencia, Alfonso and Harrow, Jennifer and Psomopoulos, Fotis and Gelpi, Josep Ll. and Chue Hong, Neil and Goble, Carole and Capella-Gutierrez, Salvador},
|
||||||
date = {2020-06-12},
|
date = {2020-06-12},
|
||||||
@ -155,8 +219,13 @@
|
|||||||
urldate = {2025-05-15},
|
urldate = {2025-05-15},
|
||||||
abstract = {The FAIR Guiding Principles, published in 2016, aim to improve the findability, accessibility, interoperability and reusability of digital research objects for both humans and machines. Until now the FAIR principles have been mostly applied to research data. The ideas behind these principles are, however, also directly relevant to research software. Hence there is a distinct need to explore how the FAIR principles can be applied to software. In this work, we aim to summarize the current status of the debate around FAIR and software, as basis for the development of community-agreed principles for FAIR research software in the future. We discuss what makes software different from data with regard to the application of the FAIR principles, and which desired characteristics of research software go beyond FAIR. Then we present an analysis of where the existing principles can directly be applied to software, where they need to be adapted or reinterpreted, and where the definition of additional principles is required. Here interoperability has proven to be the most challenging principle, calling for particular attention in future discussions. Finally, we outline next steps on the way towards definite FAIR principles for research software.},
|
abstract = {The FAIR Guiding Principles, published in 2016, aim to improve the findability, accessibility, interoperability and reusability of digital research objects for both humans and machines. Until now the FAIR principles have been mostly applied to research data. The ideas behind these principles are, however, also directly relevant to research software. Hence there is a distinct need to explore how the FAIR principles can be applied to software. In this work, we aim to summarize the current status of the debate around FAIR and software, as basis for the development of community-agreed principles for FAIR research software in the future. We discuss what makes software different from data with regard to the application of the FAIR principles, and which desired characteristics of research software go beyond FAIR. Then we present an analysis of where the existing principles can directly be applied to software, where they need to be adapted or reinterpreted, and where the definition of additional principles is required. Here interoperability has proven to be the most challenging principle, calling for particular attention in future discussions. Finally, we outline next steps on the way towards definite FAIR principles for research software.},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
language = {EN},
|
||||||
|
keywords = {project: documentation,Project: Methods Lab 🥼},
|
||||||
|
file = {/home/drezil/Zotero/storage/CCXUNESS/Lamprecht et al. - 2020 - Towards FAIR principles for research software.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Lamprecht2020TowardsFAIRPrinciples:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? unused Library catalog ("SAGE Journals")
|
||||||
|
|
||||||
@article{Lee2018Tensimplerules,
|
@article{Lee2018Tensimplerules,
|
||||||
title = {Ten Simple Rules for Documenting Scientific Software},
|
title = {Ten Simple Rules for Documenting Scientific Software},
|
||||||
@ -173,8 +242,13 @@
|
|||||||
url = {https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1006561},
|
url = {https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1006561},
|
||||||
urldate = {2025-05-15},
|
urldate = {2025-05-15},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
language = {en},
|
||||||
|
keywords = {Citation analysis,Computer software,Genome analysis,Genomics,Open source software,project: documentation,Project: Methods Lab 🥼,Software development,Software tools,Source code},
|
||||||
|
file = {/home/drezil/Zotero/storage/Y72BUDFA/Lee - 2018 - Ten simple rules for documenting scientific software.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Lee2018Tensimplerules:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? unused Library catalog ("PLoS Journals")
|
||||||
|
|
||||||
@article{PrlicProcter2012TenSimpleRules,
|
@article{PrlicProcter2012TenSimpleRules,
|
||||||
title = {Ten {{Simple Rules}} for the {{Open Development}} of {{Scientific Software}}},
|
title = {Ten {{Simple Rules}} for the {{Open Development}} of {{Scientific Software}}},
|
||||||
@ -191,10 +265,16 @@
|
|||||||
url = {https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1002802},
|
url = {https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1002802},
|
||||||
urldate = {2025-05-15},
|
urldate = {2025-05-15},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
language = {en},
|
||||||
|
keywords = {Computer software,Eyes,Open source software,project: documentation,Project: Methods Lab 🥼,Research funding,Scientists,Software tools,Source code,Sustainability science},
|
||||||
|
file = {/home/drezil/Zotero/storage/STZFWU4P/Prlić and Procter - 2012 - Ten Simple Rules for the Open Development of Scientific Software.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for PrlicProcter2012TenSimpleRules:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? Title looks like it was stored in title-case in Zotero
|
||||||
|
% ? unused Library catalog ("PLoS Journals")
|
||||||
|
|
||||||
@article{SmithEtAl2016Softwarecitation,
|
@article{Smith2016SoftwareCitationPrinciples,
|
||||||
title = {Software Citation Principles},
|
title = {Software Citation Principles},
|
||||||
author = {Smith, Arfon M. and Katz, Daniel S. and Niemeyer, Kyle E.},
|
author = {Smith, Arfon M. and Katz, Daniel S. and Niemeyer, Kyle E.},
|
||||||
date = {2016},
|
date = {2016},
|
||||||
@ -208,10 +288,16 @@
|
|||||||
urldate = {2020-09-11},
|
urldate = {2020-09-11},
|
||||||
abstract = {Software is a critical part of modern research and yet there is little support across the scholarly ecosystem for its acknowledgement and citation. Inspired by the activities of the FORCE11 working group focused on data citation, this document summarizes the recommendations of the FORCE11 Software Citation Working Group and its activities between June 2015 and April 2016. Based on a review of existing community practices, the goal of the working group was to produce a consolidated set of citation principles that may encourage broad adoption of a consistent policy for software citation across disciplines and venues. Our work is presented here as a set of software citation principles, a discussion of the motivations for developing the principles, reviews of existing community practice, and a discussion of the requirements these principles would place upon different stakeholders. Working examples and possible technical solutions for how these principles can be implemented will be discussed in a separate paper.},
|
abstract = {Software is a critical part of modern research and yet there is little support across the scholarly ecosystem for its acknowledgement and citation. Inspired by the activities of the FORCE11 working group focused on data citation, this document summarizes the recommendations of the FORCE11 Software Citation Working Group and its activities between June 2015 and April 2016. Based on a review of existing community practices, the goal of the working group was to produce a consolidated set of citation principles that may encourage broad adoption of a consistent policy for software citation across disciplines and venues. Our work is presented here as a set of software citation principles, a discussion of the motivations for developing the principles, reviews of existing community practice, and a discussion of the requirements these principles would place upon different stakeholders. Working examples and possible technical solutions for how these principles can be implemented will be discussed in a separate paper.},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {Eintrag bereinigt,PDF (Dropbox),project: documentation,Project: Methods Lab 🥼,Research Software Engineering}
|
language = {en},
|
||||||
|
keywords = {Eintrag bereinigt,PDF (Dropbox),project: documentation,Project: Methods Lab 🥼,Research Software Engineering},
|
||||||
|
annotation = {Keine weiteren Informationen gefunden},
|
||||||
|
file = {/home/drezil/Zotero/storage/XVF927LY/Smith et al. - 2016 - Software citation principles.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Smith2016SoftwareCitationPrinciples:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? unused Library catalog ("peerj.com")
|
||||||
|
|
||||||
@article{WilsonEtAl2017Goodenoughpractices,
|
@article{Wilson2017GoodEnoughPractices,
|
||||||
title = {Good Enough Practices in Scientific Computing},
|
title = {Good Enough Practices in Scientific Computing},
|
||||||
author = {Wilson, Greg and Bryan, Jennifer and Cranston, Karen and Kitzes, Justin and Nederbragt, Lex and Teal, Tracy K.},
|
author = {Wilson, Greg and Bryan, Jennifer and Cranston, Karen and Kitzes, Justin and Nederbragt, Lex and Teal, Tracy K.},
|
||||||
date = {2017-06-22},
|
date = {2017-06-22},
|
||||||
@ -227,5 +313,10 @@
|
|||||||
urldate = {2025-05-15},
|
urldate = {2025-05-15},
|
||||||
abstract = {Author summary Computers are now essential in all branches of science, but most researchers are never taught the equivalent of basic lab skills for research computing. As a result, data can get lost, analyses can take much longer than necessary, and researchers are limited in how effectively they can work with software and data. Computing workflows need to follow the same practices as lab projects and notebooks, with organized data, documented steps, and the project structured for reproducibility, but researchers new to computing often don't know where to start. This paper presents a set of good computing practices that every researcher can adopt, regardless of their current level of computational skill. These practices, which encompass data management, programming, collaborating with colleagues, organizing projects, tracking work, and writing manuscripts, are drawn from a wide variety of published sources from our daily lives and from our work with volunteer organizations that have delivered workshops to over 11,000 people since 2010.},
|
abstract = {Author summary Computers are now essential in all branches of science, but most researchers are never taught the equivalent of basic lab skills for research computing. As a result, data can get lost, analyses can take much longer than necessary, and researchers are limited in how effectively they can work with software and data. Computing workflows need to follow the same practices as lab projects and notebooks, with organized data, documented steps, and the project structured for reproducibility, but researchers new to computing often don't know where to start. This paper presents a set of good computing practices that every researcher can adopt, regardless of their current level of computational skill. These practices, which encompass data management, programming, collaborating with colleagues, organizing projects, tracking work, and writing manuscripts, are drawn from a wide variety of published sources from our daily lives and from our work with volunteer organizations that have delivered workshops to over 11,000 people since 2010.},
|
||||||
langid = {english},
|
langid = {english},
|
||||||
keywords = {project: documentation,Project: Methods Lab 🥼}
|
language = {en},
|
||||||
|
keywords = {Computer software,Control systems,Data management,Metadata,Programming languages,project: documentation,Project: Methods Lab 🥼,Reproducibility,Software tools,Source code},
|
||||||
|
file = {/home/drezil/Zotero/storage/KWWLZBNY/Wilson et al. - 2017 - Good enough practices in scientific computing.pdf}
|
||||||
}
|
}
|
||||||
|
% == BibLateX quality report for Wilson2017GoodEnoughPractices:
|
||||||
|
% Unexpected field 'publisher'
|
||||||
|
% ? unused Library catalog ("PLoS Journals")
|
||||||
|
3
background/extra-styles.css
Normal file
3
background/extra-styles.css
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
.bad-practice {
|
||||||
|
color: #888888;
|
||||||
|
}
|
Reference in New Issue
Block a user