Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourRed
titleSTATUS: IN DEVELOPMENT

...

While writing and reviewing it is important to keep in mind that the aim of the FAIR Metroline is to provide readers FAIRification guidance in an understandable and applicable way. After reading a page, a user should be able to understand the problem and take practical steps towards the solution. Pages go through the following development phases:

  • Status
    colourRed
    titleSTATUS: IN DEVELOPMENT
    : the page is or will soon be developed by people from the Writing groupGroup. See the Writing Process section for suggestions on how to write a page.

  • Status
    colourYellow
    titleSTATUS: READY FOR REVIEW
    : when the Writing Group is satisfied with the page, it is ready to be reviewed by the Reviewing Group. See the (External) Reviewing Process section for details.

  • Status
    colourGreen
    titleSTATUS: Released
    : The page has been formally released by the Editorial board. See Editorial Process for details.

...

Contributors, if possible with their ORCID, are shown at the bottom of most pages. All contributors are also be displayed on the contributors page (TODO).

The Writing Process

Contributor responsibilities

When contributing to the FAIR Metroline keep in mind the following:

  • To get a clear understanding of what is expected on in each section of a Metroline page, study the template.

  • Please adhere to the Style guide.

  • Please follow the Copyright guidelines to ensure the content you provide respects copyright . (TODO).

  • To avoid having to resolve many issues during the revision process, please check the Editors checklist and make sure you have complied with the requirements. Please make sure you comply to the Editors checklist (TODO).

  • Please make sure you acknowledge other everyone involved in your contribution in the contributors' section of the a page, after receiving their permission.

Suggested approach for writing a page:

  1. Start with a braindump - e.a. and add everything you can think of. Research your topic . Look and look for existing best-practices in e.g. sources such as the FAIR Cookbook and RMDkit.

    1. Add your text by writing e.g. mentioning your name between brackets, followed by the text. For example: [Sander] This is my text.

  2. Co-write with members from the Writing Group. Some of us meet every Friday in Utrecht to co-write, but feel free to plan co-write sessions whenever you deem suitable.

  3. When done, you feel the page is ready, notify the Writing Group to make the page available for internal review and notify the Writing Group.

    1. The Writing Group reviewers can either directly edit the page or add a comment comments with the suggested improvementimprovements.

  4. When the internal review is complete, the page will be made available for the (External) Review Group - see The (External) Review Process for more information.

...

The (External) Review Process

...

  • A page will be available for review for 3 weeks, starting the first Monday of a month

  • One week prior to a page being made available for review, we will send an email to the Review Group

  • Reviewers can add their suggestions by adding comments to a page. Please make sure the suggestions are constructive and respectful.

  • After the 3 weeks have review deadline has passed, the original Writing Group authors will address the suggestions. This may include contacting the reviewer to further clarify/discuss a suggestion. Note that even though all suggestions will be taken seriously, not all will necessarily be adopted.

  • After the suggestions comments have been addressed, the Editorial Board decides whether the page is ready to released/adopted

Editorial Board Process

  • Decides which FAIR Metroline pages are ready to be released ?

  • Ensures pages reflect the majority opinion

  • Ensures pages use a consistent style throughout

  • Ensures pages do not contain dead links

The Editorial board will convene once per two months (???)

...

.