From 738aa3bc77bd7c30bbd1746be52a675311abeb70 Mon Sep 17 00:00:00 2001 From: Yves Vincent Grossmann <89014209+yvgrossmann@users.noreply.github.com> Date: Fri, 26 Jan 2024 15:26:48 +0100 Subject: [PATCH] Iteration on SMP to better scale by size of software project (#244) * Add conditions on software application classes into the SMP catalogue * Add crosswalk document for SMP to readme file * Add new options for software licenses * Add requests from NFDI4Ing * Added conditions for application classes for the SMP catalogue * Correct Apache 2.0 option * Edit question in SMP regarding software license * Introduce software application classes into the SMP catalogue * Preparation for an cff-Plugin connected to the SMP questionnaire * Update SMP readme with SMP metadata * Update application class question in SMP with style features * add DOI for maSMP hackathon by NFDI4DS and ZB Med in readme * add optionset software identifier * change textarea to text for language and license * fix for software identifier optionsets * fix minor typos in SMP question xmi * improve standalone template and crosswalk * remove condition class 1 from specification document --------- Co-authored-by: jwindeck <39581795+jwindeck@users.noreply.github.com> Co-authored-by: juergen windeck Co-authored-by: Giacomo Lanza Co-authored-by: @GLanza Co-authored-by: Giacomo Lanza <37865804+Zack-83@users.noreply.github.com> Co-authored-by: Zack-83 <> --- README.md | 2 +- rdmorganiser/conditions/rdmo.xml | 27 ++ rdmorganiser/domain/rdmo.xml | 7 + rdmorganiser/options/rdmo.xml | 383 +++++++++++++++++++++- rdmorganiser/questions/SMP-Questions.xml | 393 +++++++++++++++++++---- rdmorganiser/questions/SMP_Readme.md | 12 +- 6 files changed, 754 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index de9b1cf4..e6707993 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ For problems or bugs with the RDMO Software, please use the issues in the [rdmo] |DCC checklist |[catalog](rdmorganiser/questions/dcc.xml) | |2018-10|RDMO team | |DFG checklist |[catalog](rdmorganiser/questions/DFG-Checkliste.xml)|[view](rdmorganiser/views/dfg-checkliste.xml) |2023-11|RDMO team | |Horizon Europe |[catalog](rdmorganiser/questions/horizon-europe.xml)|[view](rdmorganiser/views/horizon-europe.xml) |2022-12|RDMO team | -|Software Management Plan|[catalog](rdmorganiser/questions/SMP-Questions.xml) |[view (FAIR4RS)](rdmorganiser/views/FAIR4RSview.xml)|2023-08|MPDL / RDMO team| +|Software Management Plan|[catalog](rdmorganiser/questions/SMP-Questions.xml) |[view (FAIR4RS)](rdmorganiser/views/FAIR4RSview.xml)|2023-11|MPDL / RDMO team| |Swiss National Fund |[catalog](rdmorganiser/questions/snf.xml) |[view](rdmorganiser/views/snf.xml) |2020-08|RDMO team | |Bielefeld | |[view](rdmorganiser/views/bielefeld.xml) |2019-01|RDMO team | |CITEC | |[view](rdmorganiser/views/citec.xml) |2019-01|RDMO team | diff --git a/rdmorganiser/conditions/rdmo.xml b/rdmorganiser/conditions/rdmo.xml index ca0ff97f..02d527c9 100644 --- a/rdmorganiser/conditions/rdmo.xml +++ b/rdmorganiser/conditions/rdmo.xml @@ -180,4 +180,31 @@ + + https://rdmorganiser.github.io/terms + application-class-1 + + + eq + + + + + https://rdmorganiser.github.io/terms + application-class-2 + + + eq + + + + + https://rdmorganiser.github.io/terms + application-class-3 + + + eq + + + diff --git a/rdmorganiser/domain/rdmo.xml b/rdmorganiser/domain/rdmo.xml index a942e05e..f2559358 100644 --- a/rdmorganiser/domain/rdmo.xml +++ b/rdmorganiser/domain/rdmo.xml @@ -2030,4 +2030,11 @@ introduced by the Max Planck Digital Library to implement the Software Management Plan + + https://rdmorganiser.github.io/terms + application-class + smp/application-class + + + diff --git a/rdmorganiser/options/rdmo.xml b/rdmorganiser/options/rdmo.xml index e4af3785..70643f5e 100644 --- a/rdmorganiser/options/rdmo.xml +++ b/rdmorganiser/options/rdmo.xml @@ -7304,4 +7304,385 @@ ... True - + + https://rdmorganiser.github.io/terms + application-class + + 0 + + + + + + + + + https://rdmorganiser.github.io/terms + coding-standards + + 0 + + + + + + + + + + https://rdmorganiser.github.io/terms + software_identifier + list of identifiers according to cff standard 1.2.0: https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsidentifier + 0 + + + + + + + + + https://rdmorganiser.github.io/terms + software-license + + 0 + + + + + + + + + + + + + https://rdmorganiser.github.io/terms + testing + + 0 + + + + + + + + + + + + + + \ No newline at end of file diff --git a/rdmorganiser/questions/SMP-Questions.xml b/rdmorganiser/questions/SMP-Questions.xml index 8629ed1e..aa39c789 100644 --- a/rdmorganiser/questions/SMP-Questions.xml +++ b/rdmorganiser/questions/SMP-Questions.xml @@ -1,5 +1,5 @@ - + https://rdmorganiser.github.io/terms smp @@ -9,9 +9,9 @@ This SMP template was inspired by some documentation, specially: * https://opencarp.org/about/software-management-plan 98 Software Management Plan for Researchers - This catalogue is for the management of scientific software projects. It supports scientists in the development and project organisation of software developments through fifty questions in different topic blocks. This is version 2.0 of the catalogue. + This catalogue is for the management of scientific software projects. It supports scientists in the development and project organisation of software developments through fifty questions in different topic blocks. This is version 3.0 of the catalogue. Software-Management-Plan für Forschende - Dieser Katalog ist für das Management von wissenschaftlichen Software-Projekten. Er unterstützt Wissenschaftler_innen bei der Entwicklung und der Projektorganisation von Software-Entwicklungen durch fünfzig Fragen in unterschiedlichen Themenblöcken. Dies ist Version 2.0. + Dieser Katalog ist für das Management von wissenschaftlichen Software-Projekten. Er unterstützt Wissenschaftler_innen bei der Entwicklung und der Projektorganisation von Software-Entwicklungen durch fünfzig Fragen in unterschiedlichen Themenblöcken. Dies ist Version 3.0.
https://rdmorganiser.github.io/terms @@ -109,6 +109,94 @@ This SMP template was inspired by some documentation, specially: + + https://rdmorganiser.github.io/terms + application_class + smp/general/topic/application-class + The application classes are essentially based on the "DLR Software Engineering Guidelines" (https://zenodo.org/record/1344612), p. 7-8. Depending on the selection in this questions a selection of different questions is provided below. + + + False + False + 2 + The application classes are essentially based on the "DLR Software Engineering Guidelines" (<a href="https://doi.org/10.5281/zenodo.1344612" target=" _blank">https://doi.org/10.5281/zenodo.1344612</a>), p. 7-8. Depending on the selection in this questions a selection of different questions is provided below. +<details> +<summary>Click here for more information on the application classes for research software</summary> +<b>Application Class 0</b>: +<ul> +<li>Scripts to process data for a publication.</li> +<li>Simple administrative scripts to automate specific tasks.</li> +<li>Software that only demonstrates certain functions or is developed to test them.</li> +</ul> +<b>Application Class 1</b>: +<ul> +<li>Software that students develop during studies, bachelor or master theses.</li> +<li>Software resulting from dissertations in which the long-term development does not matter. </li> +<li>Software resulting from third-party projects with focus on demonstration and without planned long-term development.</li> +</ul> +<b>Application Class 2</b>: +<ul> +<li>Software resulting from dissertations in which maintainability and long-term usage matter.</li> +<li>Software from third-party projects in which maintenance and long-term usage matter beyond the project.</li> +<li>Large research frameworks which are developed by a majority of a department.</li> +</ul> +<b>Application Class 3</b>: +<ul> +<li>Mission critical software, for example, in context of aircraft, autonomous vehicles, health care, patients relation, or space missions.</li> +<li>Software for which the facility gives a warranty within or outside the own institution (e.g., via an external company).</li> +<li>Software that makes a significant contribution to third party funding and research results of the facility, and must therefore work reliably.</li> +</ul> +</details> + In which application class is the software categorised? + + + + Die Anwendungsklassen orientieren sich im Wesentlichen an den "DLR Guidelines for Research Guidelines" (<a href="https://doi.org/10.5281/zenodo.1344612" target=" _blank">https://doi.org/10.5281/zenodo.1344612</a>), S. 7-8. Abhängig von der Auswahl in diesen Fragen wird unten eine Auswahl verschiedener Fragen bereitgestellt. +<Details> +<summary>Hier finden Sie weitere Informationen zu den Anwendungsklassen für Forschungssoftware</summary> +<b>Anwendungsklasse 0</b>: +<ul> +<li>Skripte zur Verarbeitung von Daten für eine Publikation.</li> +<li>Einfache administrative Skripte, um bestimmte Aufgaben zu automatisieren.</li> +<li>Software, die nur bestimmte Funktionen demonstriert oder entwickelt wird, um sie zu testen.</li> +</ul> +<b>Anwendungsklasse 1</b>: +<ul> +<li>Software, die Studierende im Rahmen von Studien-, Bachelor- oder Masterarbeiten entwickeln.</li> +<li>Software, die aus Diplomarbeiten resultiert, bei denen die langfristige Entwicklung keine Rolle spielt. </li> +<li>Software, die aus Drittmittelprojekten mit Schwerpunkt auf Demonstration und ohne geplante langfristige Entwicklung resultiert.</li> +</ul> +<b>Anwendungsklasse 2</b>: +<ul> +<li>Software, die aus Dissertationen resultiert, bei denen Wartbarkeit und langfristige Nutzung eine Rolle spielen.</li> +<li>Software aus Drittmittelprojekten, bei denen Wartung und langfristige Nutzung über das Projekt hinaus von Bedeutung sind.</li> +<li>Große Forschungsrahmenwerke, die mehrheitlich von einer Abteilung entwickelt werden.</li> +</ul> +<b>Anwendungsklasse 3</b>: +<ul> +<li>Missionskritische Software, z.B. im Zusammenhang mit Flugzeugen, autonomen Fahrzeugen, Gesundheitsfürsorge, Patientenbeziehungen oder Weltraummissionen.</li> +<li>Software, für die die Einrichtung innerhalb oder außerhalb der eigenen Institution (z.B. über ein externes Unternehmen) eine Garantie übernimmt.</li> +<li>Software, die einen wesentlichen Beitrag zu Drittmitteln und Forschungsergebnissen der Einrichtung leistet und daher zuverlässig arbeiten muss.</li> +</ul> +</details> + In welche Anwendungsklasse wird die Software eingeordnet? + + + + + + radio + text + + + + + + + + + + https://rdmorganiser.github.io/terms intended-use @@ -118,7 +206,7 @@ This SMP template was inspired by some documentation, specially: False False - 2 + 3 The intention for developing software in a scientific context can be manifold. The same applies to the specific application of the software and the contribution to scientific knowledge. Depending on the scientific community, these points can also differ significantly from each other. We offer here some recommended reading that may be helpful in answering the questions: @@ -172,13 +260,29 @@ Es liegt in der Natur der Sache, dass diese Literaturhinweise nicht vollumfängl False False - 3 - Please consider whether it would be more effective to purchase existing software or to adapt an existing open source instead of developing software yourself. + 4 + Please consider whether it would be more effective to purchase existing software or to adapt an existing open source instead of developing software yourself. + +The following (selected) platforms can help: +<ul> +<li>bio.tools (<a href="https://bio.tools" target="_blank" >https://bio.tools</a>)</li> +<li>pypi (<a href="https://pypi.org/" target="_blank" >https://pypi.org/</a>)</li> +<li>Research Software Directory (<a href="https://research-software-directory.org/" target="_blank" >https://research-software-directory.org/</a>)</li> +<li>...</li> +</ul> What function does the new software have that previous software does not cover? What related software exists and why is it not suitable? - Bitte überlegen Sie, ob es nicht zielführender ist eine existierende Software einzukaufen oder eine bestehende Open Source-Variante anzupassen anstatt eine eigene Software vollständig selbst zu entwickeln. + Bitte überlegen Sie, ob es nicht zielführender ist eine existierende Software einzukaufen oder eine bestehende Open Source-Variante anzupassen anstatt eine eigene Software vollständig selbst zu entwickeln. + +Folgende (ausgewählte) Plattformen können hierbei helfen: +<ul> +<li>bio.tools (<a href="https://bio.tools" target="_blank" >https://bio.tools</a>)</li> +<li>pypi (<a href="https://pypi.org/" target="_blank" >https://pypi.org/</a>)</li> +<li>Research Software Directory (<a href="https://research-software-directory.org/" target="_blank" >https://research-software-directory.org/</a>)</li> +<li>...</li> +</ul> Welche Funktion hat die neue Software, die bisherige Software nicht abdeckt? Welche verwandte Software gibt es und warum ist diese nicht geeignet? @@ -213,7 +317,11 @@ Es liegt in der Natur der Sache, dass diese Literaturhinweise nicht vollumfängl - + + + + + https://rdmorganiser.github.io/terms @@ -245,7 +353,10 @@ Es liegt in der Natur der Sache, dass diese Literaturhinweise nicht vollumfängl - + + + + https://rdmorganiser.github.io/terms @@ -291,7 +402,11 @@ Als weiterführenden Hinweise empfehlen wir diese Publikationen: - + + + + + https://rdmorganiser.github.io/terms @@ -311,7 +426,11 @@ Als weiterführenden Hinweise empfehlen wir diese Publikationen: - + + + + + https://rdmorganiser.github.io/terms @@ -395,7 +514,11 @@ Als weiterführenden Hinweise empfehlen wir diese Publikationen: - + + + + + https://rdmorganiser.github.io/terms @@ -441,7 +564,10 @@ Zur Unterstützung können diese Texte interessant sein: - + + + + https://rdmorganiser.github.io/terms @@ -477,7 +603,11 @@ Beispiele für Anwendungen sind etwa eigenständige Ticket-Systeme wie Jira oder - + + + + + https://rdmorganiser.github.io/terms @@ -509,7 +639,10 @@ Beispiele für Anwendungen sind etwa eigenständige Ticket-Systeme wie Jira oder - + + + + https://rdmorganiser.github.io/terms @@ -529,7 +662,11 @@ Beispiele für Anwendungen sind etwa eigenständige Ticket-Systeme wie Jira oder - + + + + + https://rdmorganiser.github.io/terms @@ -711,7 +848,11 @@ An dieser Stelle bietet es sich zusätzlich an, zu dokumentieren, ob technische - + + + + + https://rdmorganiser.github.io/terms @@ -773,7 +914,11 @@ Folgende Literatur könnte zusätzlich interessant sein: - + + + + + https://rdmorganiser.github.io/terms @@ -805,7 +950,10 @@ Folgende Literatur könnte zusätzlich interessant sein: - + + + + https://rdmorganiser.github.io/terms @@ -837,7 +985,10 @@ Folgende Literatur könnte zusätzlich interessant sein: - + + + + https://rdmorganiser.github.io/terms @@ -869,7 +1020,11 @@ Folgende Literatur könnte zusätzlich interessant sein: - + + + + + https://rdmorganiser.github.io/terms @@ -921,7 +1076,11 @@ Folgende Literatur könnte zusätzlich interessant sein: - + + + + + https://rdmorganiser.github.io/terms @@ -1037,7 +1196,11 @@ Folgende Literatur könnte zusätzlich interessant sein: - + + + + + https://rdmorganiser.github.io/terms @@ -1129,7 +1292,10 @@ In diesem Zusammenhang ist es auch sinnvoll, über Containerisierung und generel - + + + + https://rdmorganiser.github.io/terms @@ -1173,7 +1339,10 @@ Folgende Dokumente können für Sie hierbei relevant sein: - + + + + https://rdmorganiser.github.io/terms @@ -1205,7 +1374,9 @@ Folgende Dokumente können für Sie hierbei relevant sein: - + + +
https://rdmorganiser.github.io/terms @@ -1235,7 +1406,10 @@ Folgende Dokumente können für Sie hierbei relevant sein: - + + + + https://rdmorganiser.github.io/terms @@ -1271,7 +1445,9 @@ Bitte beachten Sie hierbei nicht nur die reine Prozessebene, sondern denken Sie - + + + https://rdmorganiser.github.io/terms @@ -1280,7 +1456,7 @@ Bitte beachten Sie hierbei nicht nur die reine Prozessebene, sondern denken Sie - False + True False 1 When developing software, it can be helpful to adhere to certain standards. These can be, for example, common code conventions in the professional community or language-specific standards (e.g. <a href="https://www.oracle.com/technetwork/java/codeconventions-150003.pdf" target="_blank">Java Coding Standards</a>, <a href="https://clean-code-developer.de" target="_blank">Clean Code Developer</a>). Tools for static code analysis (e.g. Lint) can help to find problematic code. An (internal) code review can also be a suitable method of quality control. @@ -1295,15 +1471,20 @@ Bitte beachten Sie hierbei nicht nur die reine Prozessebene, sondern denken Sie - textarea + checkbox text - - + + + + + + + https://rdmorganiser.github.io/terms @@ -1323,7 +1504,11 @@ Bitte beachten Sie hierbei nicht nur die reine Prozessebene, sondern denken Sie - + + + + + https://rdmorganiser.github.io/terms @@ -1342,8 +1527,8 @@ The following questions could be answered in a documentation: * What should be documented, e.g. process, code or system? * For what purpose should documentation be done? * At what level of detail should be documented? -* Who is the target group for which type of documentation? -* In which formats will the documentation be produced? +* Who is the target group for which type of documentation, e.g. user documentation, programmers documentation, API documentation? +* In which formats will the documentation be produced, e.g. README file, docstring, release notes, changelog? How is software documentation created? @@ -1355,8 +1540,8 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: * Was soll dokumentiert werden, z.B. Prozess, Code oder System? * Zu welchem Zweck soll dokumentiert werden? * In welchem Detailgrad soll dokumentiert werden? -* Wer ist die Zielgruppe für welche Dokumentationsart? -* In welchen Formaten wird die Dokumentation erstellt? +* Wer ist die Zielgruppe für welche Art von Dokumentation, z. B. Benutzerdokumentation, Programmiererdokumentation, API-Dokumentation? +* In welchen Formaten soll die Dokumentation erstellt werden, z. B. README-Datei, Docstring, Release Notes, Changelog? Wie wird eine Software-Dokumentation erstellt? @@ -1371,7 +1556,11 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - + + + + + https://rdmorganiser.github.io/terms @@ -1403,7 +1592,10 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - + + + + https://rdmorganiser.github.io/terms @@ -1423,7 +1615,10 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - + + + + https://rdmorganiser.github.io/terms @@ -1447,14 +1642,16 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - textarea + checkbox text - + + + @@ -1517,7 +1714,11 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - + + + + + https://rdmorganiser.github.io/terms @@ -1549,7 +1750,10 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - + + + + https://rdmorganiser.github.io/terms @@ -1581,7 +1785,10 @@ Folgende Fragen könnten in einer Dokumentation beantwortet werden: - + + + + https://rdmorganiser.github.io/terms @@ -1617,7 +1824,11 @@ Eine weitreichende Möglichkeit für den langfristigen Erhalt von Software ist b - + + + + + https://rdmorganiser.github.io/terms @@ -1637,7 +1848,11 @@ Eine weitreichende Möglichkeit für den langfristigen Erhalt von Software ist b - + + + + + https://rdmorganiser.github.io/terms @@ -1677,7 +1892,11 @@ Es ist sinnvoll eine Kontaktperson oder Emailadresse zu definieren, die über ei - + + + + + https://rdmorganiser.github.io/terms @@ -1711,7 +1930,11 @@ In <a href="https://doi.org/10.15497/RDA00068" target="_blank& - + + + + + https://rdmorganiser.github.io/terms @@ -1743,7 +1966,10 @@ In <a href="https://doi.org/10.15497/RDA00068" target="_blank& - + + + + https://rdmorganiser.github.io/terms @@ -1785,7 +2011,10 @@ Weitere Literaturhinweise zu dem Thema können ebenfalls interessant sein: - + + + + https://rdmorganiser.github.io/terms @@ -1865,15 +2094,21 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - textarea + checkbox text - - + + + + + + + + https://rdmorganiser.github.io/terms @@ -1893,7 +2128,11 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - + + + + + https://rdmorganiser.github.io/terms @@ -1926,6 +2165,8 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io + + @@ -1960,6 +2201,8 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io + + @@ -1993,7 +2236,11 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - + + + + + https://rdmorganiser.github.io/terms @@ -2027,7 +2274,10 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - + + + +
https://rdmorganiser.github.io/terms/ @@ -2057,7 +2307,11 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - + + + + + https://rdmorganiser.github.io/terms/ @@ -2089,7 +2343,11 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - + + + + + https://rdmorganiser.github.io/terms/ @@ -2121,7 +2379,10 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - + + + + https://rdmorganiser.github.io/terms/ @@ -2150,7 +2411,7 @@ Beispielsweise mit einer <a href="https://citation-file-format.github.io - False + True False 0 There are good arguments for assigning a license. <a href="https://wissenschaftliche-integritaet.de/en/code-of-conduct/providing-public-access-to-research-results/" target="_blank">Guideline 13 in the DFG Code of Conduct "Guidelines for Safeguarding Good Scientific Practice"</a> even explicitly states that if "self-developed research software is to be made available to third parties, an appropriate licence is provided". <a href="https://doi.org/10.15497/RDA00068" target="_blank">FAIR4RS</a> R1.1 also emphasises the same. Please also consider the compatibility with already integrated third-party libraries. @@ -2179,14 +2440,16 @@ Folgende Seiten geben Ihnen einen ersten Überblick zu Software und Lizenzen: - textarea + checkbox text - + + + @@ -2207,7 +2470,9 @@ Folgende Seiten geben Ihnen einen ersten Überblick zu Software und Lizenzen: - + + + https://rdmorganiser.github.io/terms/ diff --git a/rdmorganiser/questions/SMP_Readme.md b/rdmorganiser/questions/SMP_Readme.md index 38967630..eb17f2bb 100644 --- a/rdmorganiser/questions/SMP_Readme.md +++ b/rdmorganiser/questions/SMP_Readme.md @@ -19,9 +19,10 @@ Furthermore, this SMP template was inspired by some documentations, specially: # Versions of the SMP Catalogue | Version Number | Release Date | Description | | -------------- | ------------ | ----------- | -| 1.0 | 5th December 2022 | Initatilisation| -| 1.1 | 27th Februrary 2023 | Minor adjustments to help texts and some widget types of questions| -| 2.0 | 18th August 2023 | a) Addition of a question regarding Qualifty References (reference to FAIR4RS I2 and R2); b) adjustments to questions and help texts for the FAIR4RS viewer; c) minor adjustments to help texts thanks to feedback; d) broken links repair + Thanks a lot for the feedback by the RDMO Community!| +| 1.0 | 5th December 2022 | Initialisation | +| 1.1 | 27th February 2023 | Minor adjustments to help texts and some widget types of questions| +| 2.0 | 18th August 2023 | a) Addition of a question regarding Qualifty References (reference to FAIR4RS I2 and R2); b) adjustments to questions and help texts for the FAIR4RS viewer; c) minor adjustments to help texts thanks to feedback; d) broken links repair + Thanks a lot for the feedback by the RDMO Community!| +| 3.0 | 29th November 2023 | Implementing application classes and structure the appearence of different question after the DLR Research Software Guidelines (https://doi.org/10.5281/zenodo.1344612). This work was done within the NFDI4DataScience miniHackathons on maSMPs in 2023 at the ZB Med, see https://doi.org/10.5281/zenodo.10374839.| # Implementing The catalogue uses the generic elements from RDMO. Therefore, all generic elements from "Conditions", "Domain", "Options" and "Questions" must already be implemented in advance. The respective order is documented in the [generic Readme file of the RDMO content](https://github.com/rdmorganiser/rdmo-catalog/tree/master/rdmorganiser#readme) and must be observed. @@ -30,7 +31,10 @@ The catalogue uses the generic elements from RDMO. Therefore, all generic elemen This catalogue introduces many custom attributes, as the generic RDMO attributes do not always cover the specific aspects of software. For this reason, the existing views in RDMO cannot be used for this catalogue, or only to a very limited extent. # Use outside RDMO -Due to multiple requests, we have created a template on the SMP for use outside of RDMO. The Word document is freely writable, has a CC0 and is freely available via https://doi.org/10.17617/2.3481986 (direct link to the docx. file: https://hdl.handle.net/21.11116/0000-000C-1076-D) for your own re-use. +Due to multiple requests, we have created a standalone SMP template for use outside of RDMO. The Word document is freely available under a CC0 license via https://doi.org/10.17617/2.3481986 (direct link to the docx file: https://hdl.handle.net/21.11116/0000-000C-1076-D) for your own re-use. + +# Metadata crosswalk to the maSMP ontology +The attributes we defined for a structured SMP have been aligned to the recommendations on machine-actionable software management plans (maSMPs) https://doi.org/10.5281/zenodo.7806638 being developed in the German SMP community. A metadata crosswalk document is published on https://doi.org/10.5281/zenodo.10275895. More SMP metadata fields for this usage are available within https://github.com/zbmed-semtec/maSMPs and https://discovery.biothings.io/ns/maSMP. # FAIR4RS Viewer A viewer for the presentation of the FAIR4RS principles is available under views. Using the Viewer only makes sense in combination with the SMP catalogue. With other RDMO catalogue this special viewer with focus on research software is not helpful. For more information, see the corresponding readme at the Viewer.