the-teachingRSE-project / competencies

The teachingRSE project: "Teaching and Learning Research Software Engineering"
Creative Commons Attribution 4.0 International
28 stars 19 forks source link

Short codes of the competencies #167

Closed MakisH closed 4 months ago

MakisH commented 1 year ago

Currently used short codes

Confusion and alternatives

For me, it was particularly difficult to guess / remember the following:

Other considerations

A glossary is actually not needed, since these are shown in the table of contents in the first page.

Related to #158. With better names, the tooltips are not needed.

MakisH commented 1 year ago

Decision: Leave it as it is for now, these have grown to be established terms for the authors.

MakisH commented 1 year ago

Looking at the HPCC skills, they also use codes:

ID: Identifier according to its position in the skill tree. Each skill may have three levels indicated by the last character of the ID: Basic, Intermediate, or Advanced

Interesting is that they nest those, such as USE4.2.1-B (Name: Workload manager introduction). This feature could be useful here, e.g., as S.DOCBB for Software>Documented Building Blocks, R.NEW for Research > Curiocity, etc.

I think it would be particularly helpful in the long run to set clear codes and ideally of a specific character width. And I think that, even though these codes have been internally established so far, it is important to polish them before the preprint gets published, because that's when inconsistencies would start to appear in literature.