Workshops Repository Documentation

[kavuong]

When working, please place the documentation associated with each bullet point of work in a new markdown file.

Also please set up pull requests for your work.

Guidance on Writing Documentation

• Should not just focus on "what" but also "how" and "why"
  • Example: why is card numbering important? what would an actual length of a card look like?
• Follow the "show not tell" principle
  • Ideas don't fully click unless they see examples to fully comprehend the idea

Objectives

• README on Workshops

• How to contribute to workshops

  • Porting existing workshop into our system
  • Adding workshop in collaboration with a company
  • Developing workshops from existing activities/labs
  • School onboarding workshop (link schools' onboarding)

• Documentation on how to code review an activity version of a workshop

  • reviewing markdown cards

• Go through entire process of developing markdown cards -> PPT that fits inside of slide template

Collaborators
@taimurkashif - README On workshops + how to contribute to workshops

• 1st and 2nd bullet points above

@KathyLiu20 - Docs on how to code review a workshop (in .md format) + Developing markdown cards -> PPT + documentation

• 3rd and 4th bullet points above

Deadline
Monday, 3/30

[kavuong]

For the third bullet point: (sorry for the essay in advance lol)

at Bit we have hosted workshops with companies like Pusher, MongoDB and Postman.

You can think of workshops as a visual medium for activities. The Postman https://docs.google.com/presentation/d/1A3EY9MzJXv0Jb2xUiGKx4kFOxai-729cIbLtdq3LklI/edit|workshop that we made were converted into two https://github.com/bitprj/curriculum/tree/master/Module_Postman/activities/Act1_Intro_to_APIs_Endpoints|Postman https://github.com/bitprj/curriculum/tree/master/Module_Postman/activities/Act2_Creating_and_Testing_BitBloxs|Activities. (two links here)

Essentially with the "code review" of the workshop, there should be some guidelines set on how to review the "activity version" of the workshop from a manager's point of view.
There should also be textual documentation explaining these guidelines fully, just like how the Bibles have documentation explain the checklist fully.

some things that could be included for example:
• Significant interactive aspect (like the BitBloxs game in Postman workshop)
• Each card conveys significant ideas
• Each card has visuals
• Logical context progression from card to card
You should look at the Postman workshop, think about how that can be converted into an activity, then think about what guidelines you would set as a manager reviewing an activity, and formalize those guidelines.

I would recommend looking at the Postman workshop and the two Postman activities I linked above. The Postman workshop is very complete. If the Postman activities as-is were stand-alone without the workshop, would they be effective on their own? What is effective and what is not effective about those activities? Coming up with and formalizing those ideas should be a great starting point!
_{View in Slack}