From 8cebf087769bf5df9808d898db2d7ce05209a80d Mon Sep 17 00:00:00 2001 From: Hugo Tavares Date: Tue, 28 Jan 2025 09:35:33 +0000 Subject: [PATCH] add author roles draft --- materials/03-authorship.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/materials/03-authorship.md b/materials/03-authorship.md index a2e9ea9..8775eb0 100644 --- a/materials/03-authorship.md +++ b/materials/03-authorship.md @@ -22,9 +22,22 @@ Each repository has a `CITATION.cff` file, which is used to automatically popula ## Author roles +We use the `website` entry to indicate **corresponding authors**. + Unfortunately, at the present the CFF format schema does not allow adding an author "role" ([see here](https://github.com/citation-file-format/citation-file-format/issues/112)). As a workaround, we use the author `alias` entry to record this information. -We don't have a formal **ontology for author roles**, although we take inspiration from [CRT](https://credit.niso.org/contributor-roles-defined/) and [DataCite](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/contributorType/). - -We use the author `website` entry to indicate **corresponding authors**. \ No newline at end of file +Although we don't have a formal **ontology for author roles**, we propose some roles below (taking inspiration from [CRT](https://credit.niso.org/contributor-roles-defined/) and [DataCite](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/contributorType/)). +Some of these roles may be slightly redundant, but they should give enough choice to capture the diversity of contributions to our materials. +We may revise this list from time to time. + +- **Conceptualisation**: Contributes original ideas to the course design and content, including proposing new topics, suggestions to structure the materials and clarification of key concepts. +- **Primary author**: Writes content from scratch or significantly revises existing materials; researches, outlines, and drafts sections in detail. +- **Editor**: Revises the content to improve clarity, flow and consistency; provides suggestions or directly makes changes to improve the quality of the writing. +- **Proofreader**: Surface-level corrections, such as grammar, spelling and formatting errors. +- **Data curation**: Finds, prepares, and tests datasets for use in demonstrations or exercises. This includes ensuring that the data is suitable for the course content and manageable within the constraints of a live course. +- **Coding**: Develops code or scripts used as part of the course content. This may include creating programming examples or writing scripts that the students use for exercises. +- **Software**: Determines and/or tests software requirements for the course and writes documentation or scripts to recreate the environment. This can be used by the computing officer for setting up training environments and by the participants to recreate the environment on their own computers after the course. +- **Scientific reviewer**: experts in the topic who evaluate the accuracy and completeness of the materials. +- **Pedagogical reviewer**: Improves the training materials focusing on pedagogy and usability, ensuring the learning objectives align with the content and exercises. +- **Project coordinator**: Oversees the writing project, ensuring timelines, roles, and objectives are met.