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

Add "learning goals" to each recipe #6

Open
Pfeil opened this issue May 3, 2022 · 0 comments
Open

Add "learning goals" to each recipe #6

Pfeil opened this issue May 3, 2022 · 0 comments
Labels
discussion enhancement New feature or request good first issue Good for newcomers

Comments

@Pfeil
Copy link
Member

Pfeil commented May 3, 2022

While the title often defines the learning goal very well, sometimes it might make sense to specify the goals explicitly.

Example: The recipe "Validate a PID record" could have the following goals:

  • Be able to understand what validation means and which kinds of validations exist.
  • Be able to apply existing validation implementations (currently not really included, as there is no API description or example, but only mentioned that the Typed PID Maker can do the basic validation).
  • Be able to implement validations.

My pro argument: This does not require the reader to see themself as a "data curator" to recognize this text is suited (avoids "target group statement per recipe")

Structure proposal:

Current recipe structure Proposal
Title Title
Learning Goals
Introduction / Summary Introduction / Summary
Ingredients Ingredients
Step-List Step-List
Step-Instructions Step-Instructions
@Pfeil Pfeil added enhancement New feature or request good first issue Good for newcomers discussion labels May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant