Developer-DAO / academy

Deprecated; V2 lives at https://github.com/developer-dao/academy-turbo
https://academy.developerdao.com
110 stars 53 forks source link

PR template for lesson content with checkboxes #202

Open wolovim opened 1 year ago

wolovim commented 1 year ago

We're starting to standardize around what we expect within lesson content. Let's codify those items as checkboxes within a PR template, so that they remain front and center.

Markkos89 commented 1 year ago

With @elPiablo we created this:


### Empowering Web3 Developers: **Guidelines for Creating High-Quality Tutorials and Content**

Lesson Components:

- [ ] A meaningful title
- [ ] Intro paragraph to clarify assumptions, and build confidence
  - Introduce learners' capabilities, competencies and experience, including proficiency with developer tools.
  - Clearly state intended learning outcome, referring to relevant previous lessons and setting context for subsequent lessons.
  - Offer estimated minimum and maximum completion times for lesson, catering to learners' respective competencies.
  - Learning extends far beyond the 'what' and 'how'. Provide the essential 'why', by showcasing real-world examples of how new knowledge can be used for social-environmental impact.
- [ ] 2nd paragraph to introduce our pedagogy and lesson structure
  - We assess prior knowledge and test learning through mini-quiz checkpoints.
  - We engage learners with prediction activities and a final quiz. Guide them to join the forum.
  - We embrace well-being by encouraging regular breaks.
- [ ] Warmup Quiz
- [ ] List of contents and relevant tools.
- [ ] A lead-in to lesson.
- [ ] Lesson chunk 
  - Meaningful digestible chunks align with learners' attention span.
  - Each chunk focuses on specific learning concepts for streamlined understanding.
  - * A mini-quiz checkpoint of ~5 multiple choice questions reinforces retention.
  - A chance for a regular break, conducive to optimal learning and a culture of well-being.
- [ ] Checkpoint quiz
- [ ] Lesson chunk
- [ ] Checkpoint quiz
- [ ] Lesson chunk 
- [ ] Checkpoint quiz
(Additional lesson chunks and their corresponding checkpoint quizzes as needed)

- [ ] * A final quiz of ~12 multiple choice questions for overall comprehension.
- [ ] Brief description of upcoming lesson to consolidate the learner’s path.
- [ ] Kudos to learner, and prompt to engage in forum with peers.

* Regarding quizzes. Checkpoint questions should be ideally focus mostly on specific information from the lesson chunk, to close the finer gaps of acquisition. Final quizzes should focus more on general comprehension of concepts. This approach also helps the author to avoid repetition.

**A few concluding considerations**:

- At Academy, we constantly ask ourselves, “what assumptions are we making about the learner’s knowledge and competencies, and to what degree do we communicate that with them?” This prevents the learner from disorientation, and fosters a favorable balance of challenge and predictability, conducive to successful learning and acquisition.
- We avoid linking to external sources and create our own supporting learning materials.
- If you like, we can create the final quiz and checkpoint quizzes on each lesson chunk.
- There will be eventual proof of learning NFTs for the learner. Give its short descriptor.
- Please don’t hesitate to reach out to [D_D Academy](https://www.notion.so/D_D-Academy-b881ff2cd10345d0b7ea97f6d4ae4cd8?pvs=21). We are passionate to take time to steward this process in any way.

From the original brainstorm document: https://www.notion.so/Guidelines-for-Educational-Content-b61f0e72a12f4045888049b9164e0b7e

What do you guys think? Shall we use this as a PR template or maybe using a Wiki Page is a better idea?

elPiablo commented 1 year ago

@wolovim ☝🏼 what's your thoughts?

wolovim commented 1 year ago

nice effort @Markkos89 @elPiablo! as most PRs are not brand new content creations, i'll suggest this live somewhere in documentation (wiki, notion, wherever) and have a link to it in the PR template. that way itll be available for those authors that need it without making for a massive PR template only relevant to a few contributors.

elPiablo commented 1 year ago

I added the following line along with accompanying asterices:

'* Regarding quizzes. Checkpoint questions should be ideally focus mostly on specific information from the lesson chunk, to close the finer gaps of acquisition. Final quizzes should focus more on general comprehension of concepts. This approach also helps the author to avoid repetition.'

elPiablo commented 1 year ago

@wolovim is template this useful, and if so, where do you think it should live/how, when and where should we present it?