paper_teaching-learning-RSE icon indicating copy to clipboard operation
paper_teaching-learning-RSE copied to clipboard

Short codes of the competencies

Open MakisH opened this issue 2 years ago • 2 comments

Currently used short codes

  • Software Engineering Skills
    • Creating documented code building blocks (DOCBB)
    • Building distributable libraries (LIBS)
    • Adapting to software life-cycle (SWLC)
    • Use repositories (SWREPOS)
    • Software Behaviour Awareness and Analysis (MOD)
  • The research skills
    • Curiosity (NEW)
    • Understanding the research cycle (RC)
    • Software re-use (SRU)
    • Software publication (SP)
    • Using domain repositories/directories (DOMREP)
  • Communication Skills
    • Working in a team (TEAM)
    • Teaching (TEACH)
    • Project Management (PM)
    • Interaction with users and other stakeholders (USERS)

Confusion and alternatives

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

  • MOD: Maybe SWMOD? Not very happy with it either.
  • NEW: Generally clear, but strange to see it in a sentence (it feels like annotation). -> Use the R in the front?
  • RC: Maybe RLC, fitting the SWLC?
  • SRU: SWREU or SWREUS?
  • SP: SWPUB

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 avatar Nov 03 '23 14:11 MakisH

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

MakisH avatar Nov 03 '23 17:11 MakisH

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.

MakisH avatar Nov 10 '23 14:11 MakisH