Κάθε άσκηση μπορεί να έχει προσεγγίσεις που σχετίζονται με αυτήν, οι οποίες περιγράφουν τους διαφορετικούς τρόπους με τους οποίους μπορεί να λυθεί μια άσκηση.
Προσέγγιση
Μια προσέγγιση πρέπει να εξερευνά πώς μπορεί να λυθεί μια άσκηση με έναν συγκεκριμένο τρόπο.
- Το περιεχόμενό της θα πρέπει είτε:
- Να εξερευνά μια ιδιωματική προσέγγιση
- Να εξερευνά μια μη ιδιωματική, αλλά ενδιαφέρουσα προσέγγιση
- Να ξεκινά με ένα (πλήρες) δείγμα κώδικα
- Χρησιμοποίησε άφθονα δείγματα κώδικα στο υπόλοιπο έγγραφο
- Μη διστάσεις να εμβαθύνεις στο θέμα
- Παράπεμψε σε χρήσιμους πόρους (π.χ. τεκμηρίωση)
- Το απόσπασμα θα πρέπει να αναδεικνύει τον πυρήνα της προσέγγισης
- Μπορούν να χρησιμοποιηθούν έως 8 γραμμές
Αν θέλεις να συγκρίνεις διαφορετικές προσεγγίσεις, γράψε ένα άρθρο.
Επισκόπηση προσεγγίσεων
- Δώσε το πλαίσιο του προβλήματος
- Περιέγραψε σημαντικά σημεία (π.χ. παγίδες) που ισχύουν για όλες τις προσεγγίσεις
- Συζήτησε τις πιο ιδιωματικές προσεγγίσεις
- Κάθε προσέγγιση θα πρέπει να ξεκινά με ένα απόσπασμα που να δείχνει την προσέγγιση
- Κράτησε το περιεχόμενο σε αρκετά υψηλό επίπεδο
- Οι λεπτομερείς πληροφορίες θα πρέπει να μπαίνουν σε μια αυτόνομη σελίδα προσέγγισης
- Παράπεμψε στην αυτόνομη σελίδα της προσέγγισης για περισσότερες πληροφορίες
- Συζήτησε πώς να επιλέγεις ανάμεσα στις προσεγγίσεις
- Ποια είναι τα υπέρ και τα κατά;
- Υπάρχουν προσεγγίσεις που ταιριάζουν καλύτερα σε συγκεκριμένες περιπτώσεις χρήσης;
Γενικές σκέψεις
- Κάποιες γλώσσες έχουν διαφορετικούς τρόπους να γράψεις το ίδιο πράγμα. Αν μέρος αυτής της σύνταξης είναι διαθέσιμο μόνο σε πιο πρόσφατες εκδόσεις της γλώσσας, σκέψου να χρησιμοποιήσεις τη "παλιά" σύνταξη. Έτσι είναι πιο πιθανό οι μαθητές να καταλάβουν τον κώδικα.
- Η εναλλακτική σύνταξη μπορεί να παρουσιαστεί στο έγγραφο της προσέγγισης
- Αν η γλώσσα σου έχει προτεινόμενο οδηγό στυλ, ακολούθησε αυτές τις οδηγίες (όπου είναι δυνατόν)
Για ποιες ασκήσεις να γράψεις προσεγγίσεις;
Γενικά, οι Ασκήσεις Εξάσκησης είναι πιο κατάλληλες για να γράψεις προσεγγίσεις, καθώς συνήθως μπορούν να λυθούν με πολλούς τρόπους.
Για τις Ασκήσεις Εννοιών, η συζήτηση της υποδειγματικής προσέγγισης μπορεί να είναι ενδιαφέρουσα. Για παράδειγμα, θα μπορούσες να δείξεις πώς η έννοια που διδάσκεται κάνει κάποιον κώδικα πιο εύκολο να γραφτεί.
Αρχεία
Κάθε προσέγγιση πρέπει να προσθέτει τα ακόλουθα δύο αρχεία:
-
.approaches/<approach-slug>/content.md: περιγραφή της προσέγγισης (δες την τεκμηρίωση)
-
.approaches/<approach-slug>/snippet.txt: απόσπασμα που δείχνει την προσέγγιση (δες την τεκμηρίωση)
Έπειτα θα χρειαστεί να προσθέσεις ή να ενημερώσεις:
-
.approaches/config.json: μεταδεδομένα για τις προσεγγίσεις (δες την τεκμηρίωση)
Ρύθμιση της επέκτασης του αποσπάσματος
Μπορείς επίσης να χρησιμοποιήσεις μια προσαρμοσμένη επέκταση αντί για την προεπιλεγμένη επέκταση .txt, ορίζοντας το πεδίο approaches.snippet_extension στο αρχείο config.json της διαδρομής σου.
Αν οριστεί, το αρχείο αποσπάσματος που πρέπει να προσθέσεις θα πρέπει να ονομάζεται .approaches/<approach-slug>/snippet.<approaches.snippet_extension>.