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. Each page is designed to be user-friendly, with clear headings, concise language, and practical examples. After reading a page, a user should be able to understand the problem, take practical steps towards the solution, and and apply the FAIR principles to their own research projects. Pages go through the following development phases :described below.

  • Status
    colourPurple
    titleSTATUS: FUTURE WORK
    : the page will be developed in the futureThis status indicates that work on this page won’t be started any time soon.

  • Status
    colourRed
    titleSTATUS: IN DEVELOPMENT
    : the page is or This status shows that active work will soon be developed started or is already being done to create the content by the Writing group. See Writing group for more information.

  • Status
    colourYellow
    titleSTATUS: READY FOR REVIEW
    : the page is ready to be reviewed At this stage, the content is drafted and checked on quality. Constructive feedback is provided by the Reviewing group, and revisions are made as necessary. See Reviewing group for more information.

  • Status
    colourGreen
    titleSTATUS: Released
    : The page This status indicates that the content has been formally released by the Editorial board and is available for public use. See Editorial Process process for details.

Updates to status are made by the Editorial board to ensure that all pages are accurately tracked and maintained throughout their lifecycle. This structured approach allows for a clear workflow and accountability, ensuring that the information provided is both current and reliable.

Content of the FAIR Metroline

...

  • You are expected to co-create pages.

  • You are expected to provide feedback on pages written by other members of the Writing group

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

  • Adhere to the Style guide

  • Ensure the content you provide respects copyright by following the Copyright guidelines (TODO).

Suggested approach for writing a page

  1. Brainstorming: Start with a braindump and add everything you can think of. Research your topic and look for existing best-practices in sources such as the FAIR Cookbook and , RMDkit, Turing way https://the-turing-way.netlify.app/index.html, DSW, FAIR Sharing and FAIR Sharing. Feel free to add other high quality sources and notify the Editorial board if you have general resources, which should be added to the list.

  2. Drafting: Add your text by mentioning your name between brackets, followed by the text. For example: [Sander] This is my text.
    Draft a clear outline that structures the content logically. Include main headings and subheadings to organize the information.
    Define the key messages and objectives for the page. What should readers learn or be able to do after reading the page?
    Where appropriate, include examples, case studies, diagrams, or other visuals to illustrate points and enhance understanding.

  3. Collaboration: 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.

  4. Notification: When the writers feel the page is ready, notify the Editorial board and they will start the feedback process.

  5. Revisions: Resolve the provided feedback, ensure your page follows the Style guide and notify the Editorial board.

...