|
| 1 | +# Lesson curating editor |
| 2 | + |
| 3 | +Many people contribute to lesson and thus are "editors" *The* lesson |
| 4 | +editor refers to the person managing all the contributions, like the |
| 5 | +editor of a [edited |
| 6 | +volume](https://en.wikipedia.org/wiki/Edited_volume). |
| 7 | + |
| 8 | +*Everyone* may "edit lessons", including merging pull requests and |
| 9 | +pushing directly, when it's appropriate. There are plenty of simple |
| 10 | +improvements that can be done without some "permission". See the left |
| 11 | +sidebar, especially :doc:`lesson-review`. |
| 12 | + |
| 13 | + |
| 14 | +## How lesson development and maintenance usually works |
| 15 | + |
| 16 | +Our lessons are quite battle-tested, and teaching isn't expected to |
| 17 | +require major edits. At most, there may be minor updates with respect |
| 18 | +to software/Github/etc. that has changed. |
| 19 | + |
| 20 | +* Minor updates are done as needed, usually right before the lesson is |
| 21 | + taught. |
| 22 | +* Github Issues with bigger ideas accumulate over time. Sometimes |
| 23 | + these are done quickly, but often they pile up. |
| 24 | +* Through this time, the lesson editor keeps an eye on things and can |
| 25 | + advise on contributions. |
| 26 | + |
| 27 | +* Every so often, there is a time for a big update. This might |
| 28 | + happen, for example, at an in-person CodeRefinery meetup or similar. |
| 29 | + |
| 30 | + * People get together and think about the big structure, making |
| 31 | + bigger changes to the lesson topics. |
| 32 | + * It's usually rough at first, but over time it gets better refined. |
| 33 | + |
| 34 | + |
| 35 | +## Responsibilities |
| 36 | + |
| 37 | +This person is *not* expected to work on the lesson alone, or even |
| 38 | +do changes all the time. They are *not* expected to always teach it, |
| 39 | +but it's good if they can stay hands-on with the teaching some. |
| 40 | + |
| 41 | +* Keep the long-term vision of the lesson and ensure the different |
| 42 | + contributions remain consistent with this. |
| 43 | +* Be very aware of the main trade-offs of CodeRefinery lessons: we |
| 44 | + have to teach something that's achievable for the common learner, |
| 45 | + not necessarily what we would do ourselves. This is a delicate |
| 46 | + balance, and lesson editors are on the front line. |
| 47 | +* Avoid too much feature creep or thing becoming too complex. |
| 48 | + Instead, it's OK to have sections with advanced material that aren't |
| 49 | + usually taught. |
| 50 | +* Manage cycles of major development. Many ideas may pile up over |
| 51 | + time, and at some point there are bigger changes. The curator |
| 52 | + should managing this process. (Or maybe, when it's time for a big |
| 53 | + change, a new curator comes in manages the |
| 54 | + rearrangement/restructuring/rewrite, and takes over as the editor) |
| 55 | +* Talking with new instructors of the lesson and briefing them on the |
| 56 | + spirit of the lesson and common pitfalls. (You aren't expected to |
| 57 | + always be the instructor, but if you can sometimes, great) |
| 58 | +* Keeping the instructor guide up to date. |
| 59 | +* Can be around for at least a few years. |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +## Qualifications |
| 64 | + |
| 65 | +* Ideally, has taught the lesson a few times so understands the flow |
| 66 | + and what usually goes right and wrong. Also ideally they've taught |
| 67 | + a few other lessons for a broader perspective. |
| 68 | +* Ideally has been around CodeRefinery for a while, so they have seen |
| 69 | + a wide variety of teaching. |
| 70 | +* Any pedagogy experience is good, but it's OK to read our guidelines. |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +# Resources |
| 75 | + |
| 76 | +* Everything under "lesson development" in the left sidebar. |
0 commit comments