Το DevDocs συμμετέχει στην κοινότητα του FreeCodeCamp

Το DevDocs είναι μια εφαρμογή ιστού ανοιχτού κώδικα που συνδυάζει τεκμηρίωση για πολλά εργαλεία προγραμματιστή σε μια διεπαφή με δυνατότητα αναζήτησης.

Χρησιμοποιώ το DevDocs από τότε που το FreeCodeCamp υπήρχε ακόμη και έχω τραγουδήσει τους επαίνους του όλα αυτά τα χρόνια.

Η ταχύτητα και η απλότητα του DevDocs είναι μια πραγματική ανάσα καθαρού αέρα. Κάθε API έχει την ίδια σαφή ιεραρχία.

Έτσι, όταν ήρθε η ώρα να σχεδιάσω τον FreeCodeCamp Guide το περασμένο καλοκαίρι, είχα ήδη ένα σαφές πρότυπο στο μυαλό μου. Επρόκειτο να δημιουργήσουμε μια διεπαφή τύπου DevDocs για να εξερευνήσουμε έννοιες προγραμματισμού.

Επικοινώνησα με τον δημιουργό του DevDocs Thibaut Courouble για συμβουλές. Ήταν χρήσιμος να εξηγήσει πώς λειτούργησε ο DevDocs και το σκεπτικό του πίσω από μερικές από τις αποφάσεις σχεδιασμού του.

Αυτός και εγώ κρατήσαμε επαφή. Ανταλλάξαμε ιδέες για το πώς να κάνουμε εργαλεία που ήταν πιο προσιτά σε προγραμματιστές σε μέρη του κόσμου χωρίς αξιόπιστες συνδέσεις στο Διαδίκτυο υψηλής ταχύτητας.

Στη συνέχεια, πριν από μερικούς μήνες, ο Thibaut με πλησίασε για τη δυνατότητα δωρεάς του έργου DevDocs στην κοινότητα του FreeCodeCamp, έτσι ώστε να μπορέσουμε να συνεχίσουμε να αναπτύσσουμε το έργο πέρα ​​από αυτό που μπορεί να κάνει ως μοναχικός συντηρητής.

Και σήμερα - ακριβώς 5 χρόνια μετά τη δημιουργία του DevDocs από την Thibaut - Είμαι ενθουσιασμένος που ανακοινώνω ότι το DevDocs είναι πλέον επίσημα μέρος της κοινότητας του FreeCodeCamp!

Μια σύντομη ιστορία των DevDocs

Η Thibaut είναι Γάλλος προγραμματιστής που εργάζεται τώρα ως ανώτερος προϊστάμενος ανάπτυξης στο Shopify στην Οτάβα του Καναδά.

Ο Thibaut δημιούργησε το DevDocs ακριβώς πριν από 5 χρόνια σήμερα, στις 26 Μαρτίου 2013. Εκείνη την εποχή, ήθελε μόνο έναν καλύτερο τρόπο για γρήγορη πρόσβαση στην τεκμηρίωση του Mozilla Developer Network.

Αρχικά, ο DevDocs ήταν απλώς ένας συνηθισμένος φάκελος τεκμηρίωσης στον σκληρό δίσκο του, για προσωπική του χρήση - το είδος που είχαν πολλοί προγραμματιστές για αναφορά. Στη συνέχεια, μετά από λίγους μήνες ανάπτυξης, η Thibaut κυκλοφόρησε το DevDocs στις 18 Ιουνίου 2013, ως δωρεάν εφαρμογή ιστού.

Αρχικά, η Thibaut κράτησε το DevDocs κλειστή πηγή. Αλλά στις 24 Οκτωβρίου 2013, το άνοιξε.

Το έργο DevDocs έχει έκτοτε συγκεντρώσει περισσότερα από 17.000 αστέρια GitHub, μαζί με 66 συνεισφέροντες (αν και η Thibaut εξακολουθεί να είναι ο πιο παραγωγικός συνεργάτης της).

Ο Thibaut έγραψε δεκάδες γραπτά σενάρια για να βγει και να κατεβάσει αυτόματα τεκμηρίωση από διαφορετικά έργα, το καθένα προσεκτικά συντονισμένο για να δημιουργήσει μια συνεπή εμπειρία ανάγνωσης και να δημιουργήσει καλά αποτελέσματα αναζήτησης.

Τα επόμενα δύο χρόνια, η Thibaut πρόσθεσε πολλές βελτιώσεις όπως νέα τεκμηρίωση, συντομεύσεις πληκτρολογίου, καλύτερη αναζήτηση, υποστήριξη για κινητά και τη δυνατότητα μετάβασης σε σκοτεινό θέμα για νυχτερινή προβολή.

Στη συνέχεια, το 2015, η Thibaut έκανε το DevDocs πλήρως λειτουργικό εκτός σύνδεσης. Ξαφνικά, ο καθένας μπορούσε να κατεβάσει ολόκληρα σετ τεκμηρίωσης για πρόσβαση εκτός σύνδεσης. Όλα αυτά τα αρχεία θα αποθηκευτούν στο πρόγραμμα περιήγησης, χάρη στην έξυπνη χρήση μιας νέας τεχνολογίας που ονομάζεται IndexedDB.

Και στις αρχές του 2016, η Thibaut πρόσθεσε υποστήριξη για εκδόσεις. Αντί να περιορίζεται μόνο στην πιο πρόσφατη έκδοση μιας τεκμηρίωσης, το DevDocs άρχισε πλέον να υποστηρίζει πολλές εκδόσεις για κάθε έργο και βιβλιοθήκη.

Αυτά τα δύο σημαντικά νέα χαρακτηριστικά θα αποδειχθούν ως σημείο καμπής στη βάση χρηστών του DevDocs. Το έργο έγινε ένα από τα πιο ευρέως χρησιμοποιούμενα εργαλεία στην κοινότητα προγραμματιστών.

Αν θέλετε να δείτε πόσο μακριά έχει φτάσει το DevDocs τα τελευταία πέντε χρόνια, συγκρίνετε αυτά τα δύο νήματα Hacker News:

  1. Το πρώτο νήμα από τον Ιούνιο του 2013 - ως επί το πλείστον οι άνθρωποι συγκρίνουν δυσμενώς το DevDocs με άλλα έργα τεκμηρίωσης (πολλά από τα οποία είναι πλέον κατεστραμμένα).
  2. Ένα δεύτερο νήμα από τα τέλη του 2017 - σε ένα από τα πιο δημοφιλή νήματα της Hacker News όλων των εποχών, οι άνθρωποι επαινούν το DevDocs - ειδικά για την ταχύτητά του. Το μήνυμα είναι ξεκάθαρο: το έργο σας δεν πρέπει να είναι το πρώτο του είδους του - απλά πρέπει να παραμείνετε σε αυτό και να κάνετε συνεπείς βελτιώσεις σε αυτό και μπορείτε να αναδείξετε τον ηγέτη.

Σήμερα, περισσότεροι από 100.000 προγραμματιστές χρησιμοποιούν το DevDocs ως αναφορά κάθε μήνα.

Πώς λειτουργεί το DevDocs κάτω από την κουκούλα

Μία από τις πιο συχνές ερωτήσεις που θέτουν οι άνθρωποι στη Thibaut: πώς έγινε το DevDocs τόσο γρήγορα;

Η Thibaut αποδίδει την ταχύτητα του DevDocs σε πολλούς παράγοντες:

  • Το DevDocs είναι μια εφαρμογή Ιστού Ruby μίας σελίδας με ένα μικρό backend
  • Όταν επισκέπτεστε το DevDocs.io, μετά την αρχική φόρτωση της σελίδας, όλα τα επόμενα αρχεία (συμπεριλαμβανομένων των αρχείων τεκμηρίωσης) ανακτώνται μέσω ενός γρήγορου δικτύου παράδοσης περιεχομένου (CDN).
  • Χρησιμοποιεί GZIP, προσωρινή αποθήκευση HTTP, προσωρινή μνήμη εφαρμογών, συνδυασμένη και ελαχιστοποιημένη JavaScript και CSS
  • Δεν υπάρχουν διαφημίσεις (οι διαφημίσεις επιβραδύνουν τα πάντα)
  • Χρησιμοποιεί το localStorage ως ένα επιπλέον επίπεδο προσωρινής αποθήκευσης για ορισμένα στοιχεία
  • Χρησιμοποιεί μια μνήμη cache για πράγματα όπως άμεση πλοήγηση προς τα πίσω και προς τα εμπρός
  • Χρησιμοποιεί το IndexedDB για προσωρινή αποθήκευση ολόκληρων συνόλων τεκμηρίωσης τοπικά στον υπολογιστή σας
  • Η τεκμηρίωση αφαιρείται από όλα τα απομακρυσμένα στοιχεία και περιττή σήμανση, με αποτέλεσμα μικρότερα αρχεία
  • Χρησιμοποιεί βελτιστοποιημένη αναζήτηση από την πλευρά του πελάτη
  • Διαθέτει μη αποκλεισμό και ασύγχρονο περιβάλλον εργασίας χρήστη
  • Διαθέτει ένα βελτιστοποιημένο δέντρο DOM με μια σελιδοποιημένη λίστα πλευρικής γραμμής, έτσι ώστε να μην χρειάζεται να αποδώσει 1.000 κόμβους αμέσως
  • Έχει μια απλή διεπαφή χρήστη που αποφεύγει τα frills όπως σκιές ή κινούμενα σχέδια

Τέλος, το DevDocs δεν χρησιμοποιεί κανένα jQuery ή κανένα πλαίσιο JavaScript. Όλες οι λειτουργίες DOM υλοποιούνται χειροκίνητα, καθιστώντας τις όσο πιο γρήγορες μπορούν. (Ο Thibaut λέει ότι δεν θα συνιστούσε αυτήν την προσέγγιση χωρίς πλαίσιο για τις περισσότερες εφαρμογές, αλλά λειτουργεί καλά για τα DevDocs.)

Πώς μπορείτε να εμπλακείτε

Αυτήν τη στιγμή αναζητούμε έναν παθιασμένο και έμπειρο προγραμματιστή Ruby που ενδιαφέρεται να γίνει μακροπρόθεσμος συνεισφέρων στο DevDocs.

Ψάχνουμε επίσης για άτομα που ενδιαφέρονται να κάνουν το DevDocs πιο εύκολο να συνεισφέρουν, γράφοντας τεκμηρίωση και αναδιαμορφώνοντας κώδικα.

Μπορείτε επίσης να βοηθήσετε, αναφέροντας τυχόν σφάλματα ή αιτήματα λειτουργιών που έχετε στο πρόγραμμα παρακολούθησης ζητημάτων και βοηθώντας σας στη διόρθωση ή την επιδιόρθωσή τους.

Μπορείτε να εγγραφείτε στην αίθουσα συνομιλιών του DevDocs στο Gitter και να εισαγάγετε τον εαυτό σας.

Τέλος, μπορείτε να βοηθήσετε χρησιμοποιώντας το DevDocs και να το μοιραστείτε με τους φίλους και τους συναδέλφους σας. Την επόμενη φορά που θα πρέπει να αναζητήσετε τεκμηρίωση, μεταβείτε στο DevDocs.io.

Μπορείτε επίσης να κάνετε αναζήτηση σε DevDocs πληκτρολογώντας "devdocs" στη γραμμή διευθύνσεων του Chrome και πατώντας την καρτέλα. Και το DuckDuckGo έχει μια ειδική !ddεντολή για αναζήτηση και σε DevDocs.

Ελάτε μαζί μου καλωσορίζοντας το Thibaut και το DevDocs στην κοινότητα του FreeCodeCamp, κάνοντας tweet σε αυτόν.

Καλή διασκέδαση και χαρούμενη κωδικοποίηση!