Restructure software architecture section to demonstrate refactoring and paradaigms

[thomaskileyukaea]

This is a re-write of section 3, to address the #227. The aim is to focus on refactoring existing code, and demonstrate the principles of OOP, functional etc through examples where they are useful, rather than explicitly teaching them as concepts. The hope is that the result will be quicker and easier to teach.

The changes rely on a new bit of code in the example project. This can be found here:

https://github.com/thomaskileyukaea/python-intermediate-inflammation/compare/thk/code-changes-for-architecture?expand=1

✅ Still to do for structural draft

• Add headers for the new pages
• Add exercises
• Review the removed questisons / objectives / keypoints to determine if they are still covered, or should be cut
• Review the removed content to determine if the important stuff is still covered

✅ Still to do for first draft

• Initial draft of content
  • Software design
  • Refactoring functions
  • Refactoring architecture
  • Decoupling code
  • YAGNI
• Update section 3 intro
• Line by line read through
• Solo run to iron out issues
• Dummy run with another person to get a sense of timing and identify issues

Still to do for final draft

• overlap between questions and objectives in 32 (general pass on Qs and objectives)
• Discuss removing mention of imperative code or give an example of the two side by side
• Starting point code merged into the inflammation repo (or else steps for checking out the branch)
• Careful read through

Nice to have

• Section on DRY and inheritance - separating out the glob into a DataSource
• Different problem for the design - try the problem we have been doing
• Introduce an exercise for looking at the patterns (if there is time)
• Maybe don't require the imports to be inside the test functions as that is

[bielsnohr]

Please change episode titles to respect title case used for all other episodes in course

[bielsnohr]

Thanks for the minor fixes. All good from my end. Passing on to other maintainers.

[douglowe]

'assess' rather than 'asses'?

[anenadic]

Merging to a local branch from Thomas's repo for easier review as Thomas's time on this project ended and then will reopen a new PR.

[anenadic]

• There is overlap between questions and objectives for lots of the episodes - would be good to understand the difference and refine this
  [snip]

The questions help learners understand what to expect from an episode/lesson as they might not yet understand the learning objectives.