Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naming proposal for units: workshop, lesson, exercise #69

Closed
terichadbourne opened this issue Oct 29, 2018 · 3 comments
Closed

Naming proposal for units: workshop, lesson, exercise #69

terichadbourne opened this issue Oct 29, 2018 · 3 comments
Assignees

Comments

@terichadbourne
Copy link
Member

I've noticed some variations in how we're all referring to the workshops and lessons on the ProtoSchool site, and it would be great to come to a consensus so we can use consistent wording both on the website and here in issues. There are three different things I can envision us needing names for:

lesson

exercise

I'm using my own proposed names as headers below:

WORKSHOP. One is the top-level category. We describe ProtoSchool as a "collection of workshops" so I've been assuming that "Basics" and "Blog" are workshops (boxed in blue above). If one were to run one of these in a live event, workshop would feel like an appropriate name to me. However, I think some folks are calling these lessons. If we're calling them something other than workshops, the paragraph at the top of the homepage should be changed to match.

LESSON. The next level down is what I think of as lessons (circled in red above). A series of them makes up the thing above that I think of as a workshop. However, on the main page these are labelled as exercises. I'd argue that since we're about to add a new workshop where you only read, rather than code, to learn, exercise is not an appropriate name, and that the main page should list these as lessons, not exercises.

EXERCISE. The third thing, which may or may not need a public-facing name, is the box where you type in code (circled in purple), which to me feels like an exercise, and is called that in our code structure. Moving forward, once we add the workshop on decentralized data structures, some lessons will have these and some won't. Right now, this box is labelled as exercise. Unless we plan to have multiple of these in a single lesson, which I don't think we should, it could be argued that we might want to remove this label to avoid the following problem: If we have a workshop with 5 lessons but only the 2nd and 4th have exercises in them, are those exercises 2 and 4 (despite 1, 3, and 5 not existing) or are they exercises 1 (confusingly delivered in lesson 2) and 2 .(confusingly delivered in lesson 4). If there's only going to be 1 per lesson, we could either label these boxes just "Exercise" or give them no header, rather than referencing an exercise number.

@mikeal et al, I'd love your opinions on this naming proposal so I can then update the site accordingly.

@mikeal
Copy link
Member

mikeal commented Oct 30, 2018

I'm +1 on these names.

Also, looking at the names of the lessons and exercises, we could use some iteration because these aren't very inviting :)

@terichadbourne
Copy link
Member Author

How would you feel about lesson names that put the user perspective more in focus by describing lessons as actions rather than nouns? For example, "Basic linking" might be "Create a link."

Action items here are:

  • Change "Exercise X" to "Lesson X" on the homepage.
  • Change "Exercise X" to just "Exercise" in the exercise boxes
  • Review lesson names to make them more inviting

@terichadbourne
Copy link
Member Author

Closed by pr #76

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants