[Update request]: Store and document / prepare your data sections

[hannesdatta]

Request to update content

Background

Content (building blocks and tutorials) has been developed over many years by different RAs and faculty members. Our platform has also undergone continuous technical development, resulting in varying content quality, with some never being revised.

The purpose of this issue is to test and update existing content, aiming to improve its quality by enhancing user experience, reflecting the latest tools or versions, and improving clarity and accuracy.

What needs to be updated?

• Store and document / prepare your data sections, see https://tilburgsciencehub.com/building-blocks/store-and-document-your-data/ and https://tilburgsciencehub.com/building-blocks/prepare-your-data-for-analysis/.

Deadline

• End of August 2023

Checklist

IMPORTANT: Before starting, ensure you are familiar with our style guide.

See this checklist below for what needs to be done.

1. "Do" the content

A first reality check can be conducted by actually WORKING with our content. Just read the building block or tutorial from the perspective of a new user.

Ask yourself the following questions:

• [ ] a. Is it clear what you will learn after reading the building block?
• [ ] b. Is the language professional and transparent, or does the content come across as amateurish?
• [ ] c. Do you run into any issues when working on this building block? Are the visuals clear?

Write down any weird things you want to fix, and keep these notes.

2. Consider the checklist below and complement your initial check with these (more formal) dimensions

• [ ] Keywords and Metadata:
  • Ensure we have complete metadata in our .md files - sometimes, keywords were only loosely entered. Can you expand them? Also, use ChatGPT or similar AI tools to generate relevant other keywords.
• [ ] Section structure and learning goals:
  • Identify a few (say, 1-3) learning goals/objectives of the building block or tutorial, and highlight them at the start.
• [ ] Title and Headings within the Content:
  • Update titles and headings to create a clear and descriptive language that accurately reflects the content's focus.
• [ ] Grammar and Style:
  • Use Grammarly or other language tools to review and correct any grammatical errors or writing inconsistencies in the content.
• [ ] Use of Code Tabs:
  • Check that code that is most optimally presented in a code box is actually included in the code box.
  • If software packages are missing from the code tab (e.g., Stata, R, Python) and you have the expertise, then please add the implementation for the other software packages.
• [ ] Use of Explanation Boxes:
  • Ensure that explanation boxes are used effectively where necessary (e.g., info, warning), providing additional context, tips, or warnings to the users.
• [ ] Media and Visuals:
  • Review and update images or screenshots to enhance the understanding of the content.
  • Add new visuals where this is needed.
  • Add proper image descriptions for accessibility.
• [ ] Links and References:
  • Verify that all links and references are still valid and point to the correct resources. Use persistent links where possible.
• [ ] Version Compatibility:
  • Ensure that the content is compatible with the latest versions of relevant software packages and tools.

3. Work on your changes and commit/do a PR (for testing and reviewing)

• Now you have a good idea of what you need to fix. Create a separate branch for your update, and commit frequently while doing your changes.
• Ask another RA to check your update and identify any other inconsistencies/problems.
• Make a pull request once the content is ready for review.

Remember to create separate branches for each update and submit pull requests once the content is ready for review. Let's collaborate and ensure Tilburg Science Hub is even more valuable for our community.

[hannesdatta]

Note that @ana-bianca-luca, @srosh2000 and @thierrylahaije have not been assigned any of the summer sprint review issues - so you can approach them for feedback on your initial revisions.

[DiSanchz]

I got it! I will move ahead with this alongside the other tasks of the summer.

[MatthijstenTije]

Is this something that still need to be worked on? @hannesdatta and @DiSanchz

Otherwise, I would like to take on the data visualization section, inside the https://tilburgsciencehub.com/building-blocks/prepare-your-data-for-analysis/.

[hannesdatta]

@MatthijstenTije - you can continue as proposed. If anything pops up / you need direction, let me know.