Versions Compared

Key

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

Status
colourRed
titleSTATUS: IN DEVELOPMENT

...

Kindly contact fairservicedesk@health-ri.nl if you consider any content to be incorrect.

Writing group

Contributing to the FAIR Metroline is a collaborative and structured process that ensures the content is accurate, comprehensive, and valuable. As part of the Writing group, you have full rights on the FAIR Metroline Confluence pages. Furthermore, you are added to the dedicated Slack channel. You will be mentioned in the Writers' section on the Contributors page.

...

  • 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.

  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.

Reviewing group

The reviewing process for contributions is critical to ensure that content is accurate, reliable, and valuable to readers. This process involves multiple steps and participants, ensuring thorough evaluation and quality control.

As part of the Reviewing group, you have comment rights on the FAIR Metroline Confluence pages. You will be mentioned in the Reviewers' section on the Contributors page.

...

  • You are expected to review pages

    • The Editorial board will communicate with timeline when and which pages are available for review after the monthly board meeting.

  • Perform a preliminary check to ensure the draft meets basic requirements. This includes checking for references, visuals, adherence to the style guide, and basic formatting.

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

  • The suggestions will be addressed. This may include contacting you to further clarify/discuss a suggestion. Note that even though all suggestions will be taken seriously, not all will necessarily be adopted.

  • After the comments have been addressed, the Editorial Board updates the status.

...