You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: building/tracks/approaches.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,22 +10,32 @@ An approach should explore how an exercise can be solved a certain way.
10
10
- Explore an idiomatic approach
11
11
- Explore a non-idiomatic, but interesting approach
12
12
- Contain a meta discussion (e.g. comparing the performance of approaches)
13
-
- Include code samples
13
+
- Start with a (full) code sample
14
+
- Liberally use code samples in the rest of the document
14
15
- Feel free to dig deep into the topic
15
16
- Link to useful resources (e.g. documentation)
17
+
- The snippet should showcase the core of the approach
18
+
- A maximum of 8 lines can be used
16
19
17
-
## Approach overview
20
+
## Approaches overview
18
21
19
22
- Give context to the problem
20
23
- Describe important points (e.g. gotchas) that apply to _all_ approaches
21
24
- Discuss the most idiomatic approaches
22
-
- Each approach should show a snippet illustrating the approach
23
-
- Keep the content fairly high-level
24
-
- Link to the idiomatic approach for more information
25
+
- Each approach should start with a snippet illustrating the approach
26
+
- Keep the content fairly high-level
27
+
- Detailed information should go into a standalone approach page
28
+
- Link to the standalone approach page for more information
25
29
- Discuss how to choose between the approaches
26
30
- What are the trade-offs?
27
31
- Are some approaches better suited for specific use cases?
28
32
33
+
## General considerations
34
+
35
+
- Some languages have different ways of writing the same thing. If some of that syntax has only become available in more recent versions of the language, consider using the "old" syntax. This makes it more likely that students will understand the code.
36
+
- Alternative syntax can be shown in the approach document
37
+
- If your language has a recommended style guide, follow those guidelines (where possible)
38
+
29
39
## What exercises to write approaches for?
30
40
31
41
In general, [Practice Exercises](/docs/building/tracks/practice-exercises) are more suitable to write approaches for, as they usually can be solved in multiple ways.
0 commit comments