Versions Compared

Key

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

...

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

  • Status
    colourPurpletitleSTATUS: READY FOR WG REVIEW
    : the page is ready for internal review by the Working Group.
    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: ADOPTED
    : The page has been formally adopted by the Editorial board. See Editorial Process for details.

...

The Metroline pages are based on a template. Read more about the template and what is expected for each paragraph here. Furthermore, please read our Style guide.

Suggested approach for writing a page:

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

    1. Add your text by writing e.g. [Sander] This is my text.

  2. Co-write with members from the working groupWriting 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, make the page available for internal review and notify the Working Writing Group.

    1. Working The Writing Group Reviewers reviewers can either directly edit the page or add a comment with the suggested improvement

    Next, the Review Group will add comments/suggestions

    1. The original writers should address these comments. See The .

  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

    .

While writing, keep in mind:

...

The general description of page:

  • Should be readable for everyone and based on research

The how-to section of a page:

...

Should aspire to be readable for everyone, but, depending on the topic, may require specialised knowledge.

...

Should be a general, widely applicable approach

...

  1. .

...

Keep it practical and simple. Keep in mind: if I would come to this page looking for a solution to this problem, would this How-to actually help me solve this problem.

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

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

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

...