Skip to content

Conversation

Zack-83
Copy link
Member

@Zack-83 Zack-83 commented Jun 6, 2025

Arbeitsdokument hier

  • @stephanbrosig: Kriterion "Documentation requirements" verbessern
  • @jhrohrwild: Beispielprojekt vervollständigen
  • @ alle: "Tab" oder "Set" mit einer besseren Benennung ersetzen
  • @ alle: Beispielnamen ergänzen
  • @ alle: Spezialeffekte platzieren (Akkordeon, Bilder)
  • @stephanbrosig @Sabine-Schoenau: deutschen und englischen Text auf Köhärenz prüfen; Spiegel über Dokumentation einheitlich auf Deutsch und Englisch implementieren
  • @Zack-83: in romanische Sprachen übersetzen

@Zack-83 Zack-83 requested a review from sa-wetter September 8, 2025 10:06
@Zack-83 Zack-83 marked this pull request as ready for review September 8, 2025 10:07
Copy link
Collaborator

@jhrohrwild jhrohrwild left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I caused a mess by forgettuing to delete one item in the google docs. This should be deleted in all parts.
Plus one imporvement (at least in my mind) by moving on paragraph below the detail end tag (so that is always visible)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the texts I would move one part out of the "details" element and I seem to habe left a suprious sentence in the google docs that has the depreciated term dta category instead of data set. So sorry!

Correction like this?

%%%%%%%%

Assign a meaningful but short name to each "data set" with reference to the research question, and use it to label the corresponding tab in RDMO.

<details><summary style="cursor:pointer">Some tips for choosing data sets</summary>

You can proceed like that:
[[...]]

[[* Assign a meaningful but short name to each "data category" with reference to the research question, and use it to label the corresponding tab in RDMO. Then describe each data category using the checkboxes/text fields on this page and the following ones. - **This is suprious as we already have the same text before the "details" part - one could append the last sentence "Then describe each data set using the checkboxes/text fields on this page and the following ones." to the sentence before the "details" part. Note that data category should be data set! **]]

Examples of two project with data organised in categories is to be found on the <a href="https://gl.mathhub.info/cdi/labs/literacy/proposal-self-service/-/blob/main/RDMO/Beispiele_und_Hilfen/Hilfe_Datenkategorie_en.md" target="_blank">GitLab page</a>.

</details>

Please fill in the form for each tab. The same tabs may be used later on other pages. You can add a new tab using the green button. Once created, you can edit or delete tabs using the buttons in the top right corner.

[[This last paragraph should be movedoutside of the details part. As we should desplay it to all users even if they do not klick on the details part.]]

* Evaluate each data category with respect to the following criteria:
* origin/generation: generated (observation/measurement, experiment, survey, simulation, web-crawl,…) or reused;
* storage (space) requirements: e.g.: &lt;1GB, ~10TB
* documentation requirements: e.g. extensive description of survey sampling and survey implementation or detailed references to meta-data and re-used data retrieved from a research data repository
Copy link
Member Author

@Zack-83 Zack-83 Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* documentation requirements: e.g. extensive description of survey sampling and survey implementation or detailed references to meta-data and re-used data retrieved from a research data repository
* documentation requirements:
* example A: extensive description of survey sampling and survey implementation;
* example B: measurement setup and measuring parameters

Zack-83 and others added 8 commits October 8, 2025 10:41
examples for docu requirements added
add examples for data documentation
Examples for docu requirements added
add examples A and B for documentation requirements
add header "Structuring into data sets" and the introductory sentence ("The following questions deal with...")
add examples A and B for documentation requirements
Title "Strukturierung der Datensätze" u Einleitungssatz ("Die folgenden Fragen befasssen sich mit...") added
Copy link
Collaborator

@stephanbrosig stephanbrosig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation requirements (with Examples A and B) need to be changed also in German version.
Headline "Strucuturing into data sets" does not exist in catalogs without introductory text. We think that is ok.

Zack-83 and others added 11 commits October 10, 2025 10:31
Beispiele A und B auf deutsch
include (re-)use in title and amend intro text
removed remove &lt;details&gt;
because "Some tips for subdividing project data into data sets" is sufficient
replaced "clustering" by "subdividing" to make consistent with usage of this term below. "subdividing" is recommended when active grouping is referred to rather than grouping by algorhythms.
further changes in English version of help text data-categories
English version completed again
help text data categories German
data categories help text EN and GER
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants