Skip to content

Commit

Permalink
differences for PR #47
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 1, 2022
1 parent 442addc commit 689dd28
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 21 deletions.
144 changes: 125 additions & 19 deletions 17-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,6 @@ teaching: 25
exercises: 5
---

- The Incubator/Lab/Lesson Program ecosystem
- How all these things fit together
- The lesson life cycle
- Stages: pre-alpha, alpha, beta, stable
- Pilot workshops
- Why these are important
- (Briefly) the practicalities of organising/teaching them, collecting feedback, etc
- Lesson publication and review
- Connecting with The Carpentries curriculum community
- the lesson-dev Slack channel
- creating your own Slack channel for your lesson
- the incubator-developers TopicBox list
- co-working sessions
- further resources for lesson developers

::::::::::::::::::::::::::::::::::::::: objectives

- Describe the life cycle of a lesson.
Expand All @@ -35,22 +20,143 @@ exercises: 5

::::::::::::::::::::::::::::::::::::::::::::::::::

Until now, this training has focused on the internals of a lesson development project.
Now it is time to consider the context in which this lesson development can take place.

## The Carpentries Lesson Development Ecosystem

[The Carpentries Incubator][carpentries-incubator] is a space for The Carpentries community
to collaborate on lessons.
It provides a single location where our community can come to
find lessons that are being developed by the community,
and to create new lessons using The Carpentries Workbench.
Community members retain ownership of their lessons hosted in the Incubator,
while benefiting from the increased findability it gives to the lesson.

The Carpentries supports the lesson developer community working in the Incubator
with training (like this one),
communications designed to raise awareness of lesson projects within the community,
and platforms for the community to discuss and collaborate on lesson development.

The Carpentries also provides a space for community-developed lessons
to reside after the initial phases of development have been completed.
[The Carpentries Lab][carpentries-lab] hosts a repository for open peer-review of lessons,
and a collection of lessons that have passed through this review process
and can be considered ready to teach by any Instructor with sufficient knowledge of the topic.
In the future, this lesson review process may also be used to determine when a lesson
in the Incubator is ready to be incorporated into one of The Carpentries _Lesson Programs_,
the collection of lessons and curricula that can be taught in an official workshop for
Software, Library, or Data Carpentry.


## The Lesson Life Cycle

To make it easier for other community members to
assess the current state of a lesson in the Incubator,
The Carpentries encourages lesson developers to indicate the status of their lesson
by labeling its progress through a _lesson life cycle_:

![The life cycle of a lesson](fig/life_cycle.png){alt="Diagram of the life cycle of a
lesson in The Carpentries ecosystem. A lesson is proposed at the beginning of the
pre-alpha stage. It enters alpha when it is taught for the first time. In beta, it is
taught by other instructors. A full release of the lesson is made when it is stable.
Pilot workshops take place during the alpha and beta phases. The Carpentries Lab hosts
open peer review of lessons that have completed the beta phase."}

Each life cycle stage indicates the level of maturity of a lesson:

- **pre-alpha**: a first draft of the lesson is still being constructed.
- **alpha**: the lesson has been/is being taught by the original authors, but has not been fully tested.
- **beta**: the lesson is ready to be taught by instructors who have not been significantly involved in its developed to this point.
- **stable**: the lesson has been extensively tested by the authors and others. It can be considered broadly complete and unlikely to undergo any drastic changes without warning.

The life cycle stage of a lesson is displayed as a banner on the lesson site,
as a label on the lesson GitHub repository,
and alongside the lesson whenever it is shown on The Carpentries websites
and lesson listings.


## Pilot Workshops

In line with [the importance we placed on evaluation of lesson content earlier in this training](03-audience.md),
the life cycle described above places considerable emphasis on
the testing of lessons in **pilot workshops**.

For these pilot workshops to provide an effective evaluation of the lesson,
it is essential to seize the opportunity they provide to collect feedback and data.
For example, a pilot workshop offers a chance to answer questions like:

- How much time does it take to teach each section of the lesson?
- How much time is required for each exercise?
- What technical issues were encountered during the lesson?
- What questions did learners ask during the workshop?
- Which parts of the lesson were confusing for learners?
- Which exercises could be improved to provide more information to the instructors?

[The pilot workshop notes template][pilot-notes-template] provides a starting point,
but it takes a lot of time and effort to keep track of all this information
during a pilot workshop.
It can be helpful to assign this task to a member of the lesson development team,
who can dedicate themselves to observing the pilot and taking notes.
As soon as the pilot has finished,
it is a good idea to take some time to share the notes with the other lesson authors,
to reflect on and discuss the experience of teaching the lesson,
and to synthesise the lesson notes and any action items that come from this debrief
into specific action items to improve the lesson.
These should be added as new issues on the lesson repository,
to help you keep track of the work that needs doing for the next iteration.

For beta pilot workshops,
where the lesson is taught by instructors who have not yet made a major contribution to its development,
it is vital that instructors have the opportunity before the workshop
to learn about the lesson from the authors,
and to debrief with the authors afterwards so that they can
share their experience and observations about how the lesson could be further improved.


::: callout

## Hosting and Teaching Pilot Workshops

The Carpentries community handbook includes
[guidance for community members who want to teach and/or host pilot workshops][handbook-pilot-workshops].

:::::::::::


## Connecting with the Lesson Developer Community

With over 100 lessons under development in The Carpentries Incubator,
the lesson developer community is thriving.
Connecting with this community can be a great way to
find collaborators to contribute to or test your lesson,
to stay up to date with the latest support provided to the community,
and to learn from the experience of others.

Here are a community activities and channels that you might be interested in joining:

- The `lesson-dev` channel on [The Carpentries Slack workspace](https://swc-slack-invite.herokuapp.com/). This is a platform for the community to ask questions and make announcements about lesson development. You could also browse the other channels on the workspace for any that are relevant to the topic of your lesson.
- You may also find it helpful to create a new channel on Slack for discussion of your lesson. Chat channels like this can be valuable ways for a remote team to communicate and collaborate.
- [The `incubator-developers` list on TopicBox](https://carpentries.topicbox.com/groups/incubator-developers). The Carpentries Curriculum Team uses this mailing list to make relevant announcements to the community of lesson developers working in Incubator.
- The Carpentries Curriculum Team hosts monthly Lesson Development Coworking Sessions, which are a good opportunity to engage with other lesson developers and make regular progress on your project. The sessions are listed on [The Carpentries community calendar](https://carpentries.org/community/#community-events).


:::::::::::::::::::::::::::::::::::::: challenge

## Exercise: join relevant channels (5 minutes)

TODO: time for participants to find and join relevant communication channels

Use this time to explore the options listed above
and join/subscribe to any communication channels that you find interesting.

::::::::::::::::::::::::::::::::::::::::::::::::::



:::::::::::::::::::::::::::::::::::::::: keypoints

- First key point. Brief Answer to questions. (FIXME)
- New lessons are developed in The Carpentries Incubator and reviewed in The Carpentries Lab.
- Teaching a lesson for the first time is an essential intermediate step in the lesson development process.
- First key point. Brief Answer to questions. (FIXME)
- The Carpentries lesson developer community shares their experience on multiple communication channels.

::::::::::::::::::::::::::::::::::::::::::::::::::

Expand Down
Binary file added fig/life_cycle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions links.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[blooms]: https://cft.vanderbilt.edu/guides-sub-pages/blooms-taxonomy/
[carpentries-incubator]: https://carpentries-incubator.org/
[carpentries-lab]: https://carpentries-lab.org/
[carpentries-website]: https://carpentries.org/
[dc]: https://datacarpentry.org/
[github]: https://github.com/
[glosario]: https://glosario.carpentries.org/
[hacker-2000]: https://doi.org/10.1037/0022-0663.92.1.160
[handbook-pilot-workshops]: https://docs.carpentries.org/topic_folders/lesson_development/lesson_pilots.html
[kirschner-2006]: https://github.com/carpentries/instructor-training/blob/gh-pages/files/papers/kirschner-minimal-guidance-fails-2006.pdf
[lc]: https://librarycarpentry.org/
[pilot-notes-template]: https://codimd.carpentries.org/lesson-pilot-observation-notes-template#
Expand Down
4 changes: 2 additions & 2 deletions md5sum.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"LICENSE.md" "3e2c0d19ace00f148c3bfc2f403fc6c6" "site/built/LICENSE.md" "2022-02-01"
"config.yaml" "281cc09a01681dd58509a621747d50c1" "site/built/config.yaml" "2022-02-17"
"index.md" "89ed0f2f2b47849e343355f18954ddc8" "site/built/index.md" "2022-02-03"
"links.md" "9ef71098138baf5becf8611028f7824a" "site/built/links.md" "2022-06-01"
"links.md" "813517ec868d9be855172b1c36aa31b4" "site/built/links.md" "2022-06-01"
"episodes/01-introduction.md" "5d1535df746928463007f206eb92676e" "site/built/01-introduction.md" "2022-05-31"
"episodes/02-lessons.md" "902df366d7ab495319747c89b54aadc0" "site/built/02-lessons.md" "2022-03-25"
"episodes/03-audience.md" "9fce0b46b4ebd19c3b02bea93bdea4b6" "site/built/03-audience.md" "2022-05-06"
Expand All @@ -20,7 +20,7 @@
"episodes/14-long-break.md" "3a4802231bb8e44cc6c132d86afb7f78" "site/built/14-long-break.md" "2022-02-01"
"episodes/15-explanation.md" "22fc67438311f618d5ad264dc41628a5" "site/built/15-explanation.md" "2022-06-01"
"episodes/16-short-break.md" "05d1044278ce40ab59d9397db1f0e383" "site/built/16-short-break.md" "2022-02-01"
"episodes/17-operations.md" "333fa7d483619d6fec87c0302b06f466" "site/built/17-operations.md" "2022-02-01"
"episodes/17-operations.md" "8679a2583148fb7d6568a281f584a373" "site/built/17-operations.md" "2022-06-01"
"episodes/18-preparing.md" "ea5b3ee7743c7c09de9b7731bb27bcfa" "site/built/18-preparing.md" "2022-06-01"
"episodes/19-wrap-up2.md" "11093cef022b40e71daada2a5814f830" "site/built/19-wrap-up2.md" "2022-06-01"
"episodes/20-reflecting.md" "f5f307acbf0d39dd52fbb6354fdb060e" "site/built/20-reflecting.md" "2022-03-28"
Expand Down

0 comments on commit 689dd28

Please sign in to comment.