Skip to content

Commit 4dd46a3

Browse files
authored
Added
1 parent b50dda3 commit 4dd46a3

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

_extras/guide.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,19 @@ title: "Instructor Notes"
1111
## Course Design
1212
The course follows a narrative around a software development team working on an existing software project that is analysing patients’ inflammation data (from the [novice Software Carpentry Python course](https://software-carpentry.org/lessons). A typical learner for the course is someone who has gained foundational software development skills in using Git, command line shell and Python (e.g. by attending prior courses or by self-learning). They are now joining the development team where they will require a number of software development tools and intermediate software development skills to engineer their code more properly taking into consideration the lifecycle of software, team ethic, writing software for stakeholders, and applying a process to understanding, designing, building, releasing, and maintaining software.
1313

14-
The course has been separated into four sections:
14+
The course has been separated into four sections which can be delivered in 4 half-day units:
1515

1616
- Section 1: Setting up Collaborative Software Development Environment
1717
- Section 2: Verifying Software Correctness at Scale
1818
- Section 3: Developing Open Source and Inner Source Ready Code
1919
- Section 4: Managing the Quality and Evolution of Software
2020

21-
The course is intended for learners to work individually and in groups in small breakout rooms aided by a helper, which provides a more comfortable and less intimidating learning environment with learners more willing to engage and chat with their colleagues about what they are doing and ask for help. While this course can be
22-
live-coded by an instructor as well, we felt that intermediate-level learners would not require this and are capable of going through the material on their own. Exercises in later sections include team work where learners are organised in groups to collaborate on a software project (to provide more in-depth practice for software development in teams). At the end of each section, you can run a Q&A session for the whole group to cover any questions and provide opportunity for discussions.
21+
## Course Delivery
22+
The course is intended for self-learning - students are organised in small groups but work individually through the material and have a bunch of helpers on hand to help with any issues and questions. This provides a more comfortable and less intimidating learning environment with learners more willing to engage and chat with their group colleagues about what they are doing and ask for help. While this course can be live-coded by an instructor as well, we felt that intermediate-level learners would not require this and are capable of going through the material on their own at a reasonable speed. Exercises in later sections include team work where learners from the ame group are asked to collaborate on a software project (to provide more in-depth practice for software development in teams).
2323

24+
Workshops can be delivered online or in-person with participants split into groups or breakout rooms from the outset - these groups are aided by helpers.
25+
A good ratio is 4-6 learners to 1 helper. If you have a smaller number of helpers than groups - helpers can roam around to make sure groups are making progress.
26+
27+
The workshop kicks off with everyone together at the start of each day, where course leads provide session introduction and explain what the students will be learning on each day. After that, participants are split into groups and go through the materials for that day on their own with helpers are on hand to answer questions. At the end of each day, all reconvene for a joint Q&A session, feedback and wrap-up. In addition to the section intros on each day, there is a course introduction and motivation on the first day of the workshop to set the overall scene and expectations.
2428

2529
{% include links.md %}

0 commit comments

Comments
 (0)