search

guardian / coding-exercises

Coding exercises
447 stars 175 forks source link

refactor: Organise the Scrabble exercise into "background" and "tasks" #53

Closed akash1810 closed 3 years ago

akash1810 commented 3 years ago

What does this change?

This change aims to make the Scrabble exercise easier to follow.

Currently, the background information/facts are interleaved with the tasks.

This change creates two sections:

  1. "background" to state the letter scores and distribution in tabular form
  2. "tasks" to list the tasks in a true markdown list. Hopefully, this makes the order of tasks clearer.

This brings the Scrabble exercise in line with other exercises such as 21s and Game of Life.

Also adds a new header image.

See it here. The screenshot below also shows a before and after.

How can we measure success?

The Scrabble exercise is easier to follow.

Images

image

akash1810 commented 3 years ago

Was going to suggest changing 'distribution' to 'no. of tiles'

I started with this, but the two tables looked too similar and thought it might be a little confusing as a result. One might accidentally lookup scores in the distribution table when performing the exercise IRL and vice-versa.

twrichards commented 3 years ago

Great improvements. How do the tables look when copied and pasted into IDE? as lots of candidates copy/paste them into comments above their code when making their data structures.

akash1810 commented 3 years ago

How do the tables look when copied and pasted into IDE?

Still usable, though the alignment of E in distribution is questionable!

image