Skip to content

Commit e8d390b

Browse files
ErikSchierboommirkoperillo
authored andcommitted
Cross-reference concept exercise file information
[Docs] Cross-reference concept exercise file information
1 parent 18eb75f commit e8d390b

1 file changed

Lines changed: 15 additions & 60 deletions

File tree

reference/implementing-a-concept-exercise.md

Lines changed: 15 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ As this document is generic, the following placeholders are used:
2424

2525
Before implementing the exercise, please make sure you have a good understanding of what the exercise should be teaching (and what not). This information can be found in the exercise's GitHub issue. Having done this, please read the [Java Concept exercises introduction][concept-exercises]. If you have come up with something completely new, create a new issue _first_ so we can discuss the Concept Exercise.
2626

27-
To implement a Concept Exercise, the following files must be created:
27+
To implement a Concept Exercise, the following files must be added:
2828

2929
<pre>
3030
languages
@@ -36,7 +36,8 @@ languages
3636
| |── instructions.md
3737
| |── introduction.md
3838
| |── hints.md
39-
| └── after.md (optional)
39+
| ├── after.md
40+
| └── source.md (required if there are third-party sources)
4041
|── .gitignore
4142
|── .meta
4243
| |── design.md
@@ -57,50 +58,7 @@ languages
5758
└── &lt;slug&gt;Test.java
5859
</pre>
5960

60-
## Step 1: add .docs/introduction.md
61-
62-
This file contains an introduction to the concept. It should make the exercise's learning goals explicit and provide a short introduction with enough detail for the student to complete the exercise. The aim is to give the student just enough context to figure out the solution themselves, as research has shown that self-discovery is the most effective learning experience. Using the proper technical terms in the descriptions will be helpful if the student wants to search for more information. If the exercise introduces new syntax, an example of the syntax should always be included; students should not need to search the web for examples of syntax.
63-
64-
As an example, the introduction to a "strings" exercise might describe a string as just a "Sequence of Unicode characters" or a "series of bytes". Unless the student needs to understand more nuanced details in order to solve the exercise, this type of brief explanation (along with an example of its syntax) should be sufficient information for the student to solve the exercise.
65-
66-
## Step 2: add .docs/instructions.md
67-
68-
This file contains instructions for the exercise. It should explicitly explain what the student needs to do (define a method with the signature `public String X(String s)` that takes an A and returns a Z), and provide at least one example usage of that function. If there are multiple tasks within the exercise, it should provide an example of each.
69-
70-
## Step 3: add .docs/hints.md
71-
72-
If the student gets stuck, we will allow them to click a button requesting a hint, which shows this file. This will not be a "recommended" path and we will (softly) discourage them using it unless they can't progress without it. As such, it's worth considering that the student reading it will be a little confused/overwhelmed and maybe frustrated.
73-
74-
The file should contain both general and task-specific "hints". These hints should be enough to unblock almost any student. They might link to the docs of the functions that need to be used.
75-
76-
The hints should not spell out the solution, but instead point to a resource describing the solution (e.g. linking to documentation for the function to use).
77-
78-
## Step 4: add .docs/after.md
79-
80-
Once the student completes the exercise they will be shown this file, which should provide them with a summary of what the exercise aimed to teach. This document can also link to any additional resources that might be interesting to the student in the context of the exercise.
81-
82-
## Step 5: update languages/java/config.json
83-
84-
An entry should be added to the track's `config.json` file for the new Concept Exercise:
85-
86-
```json
87-
{
88-
...
89-
"exercises": {
90-
"concept": [
91-
...
92-
{
93-
"slug": "<slug>",
94-
"uuid": "<uuid>",
95-
"concepts": ["<concept-1>"],
96-
"prerequisites": ["<prerequisite-1>", "<prerequisite-2>"]
97-
}
98-
]
99-
}
100-
}
101-
```
102-
103-
## Step 6: adding track-specific files
61+
## Step 1: Add code files
10462

10563
The configuration files may be copied from another exercise. We aim to keep these in sync:
10664

@@ -112,29 +70,25 @@ Now create the following three files:
11270
- `src/test/java/<slug>Test.java`: the test suite.
11371
- `.meta/example/src/main/java/<slug>.java`: an example implementation that passes all the tests.
11472

115-
## Step 7: add analyzer (optional)
116-
117-
Some exercises could benefit from having an exercise-specific [analyzer][analyzer]. If so, specify what analysis rules should be applied to this exercise and why.
118-
119-
Skip this step if you're not sure what to do.
73+
## Step 2: Add documentation files
12074

121-
## Step 8: custom representation (optional)
75+
How to create the files common to all tracks is described in the [how to implement a concept exercise document][how-to-implement-a-concept-exercise].
12276

123-
Some exercises could benefit from having an custom representation as generated by the [Java representer][representer]. If so, specify what changes to the representation should be applied and why.
77+
## Step 3: Update list of implemented exercises
12478

125-
Skip this step if you're not sure what to do.
79+
- Add the exercise to the [list of implemented exercises][implemented-exercises].
12680

127-
## Step 9: add `.meta/design.md`
81+
## Step 4: Add analyzer (optional)
12882

129-
This file contains information on the exercise's design, which includes things like its goal, its teaching goals, what not to teach, and more. This information can be extracted from the exercise's corresponding GitHub issue.
83+
Some exercises could benefit from having an exercise-specific [analyzer][analyzer]. If so, specify what analysis rules should be applied to this exercise and why.
13084

131-
## Step 10: add .meta/config.json:
85+
_Skip this step if you're not sure what to do._
13286

133-
This file contains meta information on the exercise, which currently only includes the exercise's contributors.
87+
## Step 5: Add representation (optional)
13488

135-
## Inspiration
89+
Some exercises could benefit from having an custom representation as generated by the [Java representer][representer]. If so, specify what changes to the representation should be applied and why.
13690

137-
When implementing an exercise, it can be very useful to look at the exercises the track has already implemented. You can also check the exercise's [general concepts documents][reference] to see if other languages that have already an exercise for that Concept.
91+
_Skip this step if you're not sure what to do._
13892

13993
## Inspiration
14094

@@ -153,3 +107,4 @@ If you have any questions regarding implementing the exercise, please post them
153107
[docs-features-of-v3]: ../../../docs/features-of-v3.md
154108
[anatomy-of-a-concept-exercise]: https://www.youtube.com/watch?v=gkbBqd7hPrA
155109
[reference]: ../../../reference/README.md
110+
[implemented-exercises]: ../exercises/concept/README.md#implemented-exercises

0 commit comments

Comments
 (0)