Skip to content

Commit 41fe3d0

Browse files
ErikSchierboomkytrinyxee7
authored
Add more approaches guidance (#398)
Add more approaches guidance Co-authored-by: Katrina Owen <[email protected]> Co-authored-by: ee7 <[email protected]>
1 parent fba86ef commit 41fe3d0

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

building/tracks/approaches.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,32 @@ An approach should explore how an exercise can be solved a certain way.
1010
- Explore an idiomatic approach
1111
- Explore a non-idiomatic, but interesting approach
1212
- 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
1415
- Feel free to dig deep into the topic
1516
- 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
1619

17-
## Approach overview
20+
## Approaches overview
1821

1922
- Give context to the problem
2023
- Describe important points (e.g. gotchas) that apply to _all_ approaches
2124
- 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
2529
- Discuss how to choose between the approaches
2630
- What are the trade-offs?
2731
- Are some approaches better suited for specific use cases?
2832

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+
2939
## What exercises to write approaches for?
3040

3141
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

Comments
 (0)