DevDocs este o aplicație web open source care combină documentația pentru o mulțime de instrumente pentru dezvoltatori într-o singură interfață de căutare.

Folosesc DevDocs încă dinainte ca Routech să existe și există i-a cântat laudele de-a lungul anilor.

DevDocs se alatura comunitatii Routech
Pagina de destinație simplă, fără sens, a DevDocs – cu documentație API navigabilă de-a lungul stânga

Viteza și simplitatea DevDocs este o suflare de aer proaspăt. Fiecare API este așezat în aceeași ierarhie clară.

1611456008 798 DevDocs se alatura comunitatii Routech
O captură de ecran a DevDocs.io și interfața sa intuitivă de navigare a documentației API

Deci, când a venit timpul să proiectăm ghidul Routech vara trecută, aveam deja în minte un șablon clar. Aveam de gând să creăm o interfață asemănătoare DevDocs pentru explorarea conceptelor de programare.

Am contactat creatorul DevDocs, Thibaut Courouble, pentru sfaturi. El a fost de ajutor în a explica modul în care a funcționat DevDocs și raționamentul său din spatele unora dintre deciziile sale de proiectare.

DevDocs se alatura comunitatii Routech
Creatorul DevDocs, Thibaut Courouble

El și cu mine am păstrat legătura. Am schimbat idei despre cum să facem instrumente care să fie mai accesibile dezvoltatorilor din părți ale lumii fără conexiuni de internet de mare viteză fiabile.

Apoi, în urmă cu câteva luni, Thibaut m-a abordat cu privire la posibilitatea de a dona proiectul DevDocs către comunitatea Routech, astfel încât să putem continua să dezvoltăm proiectul dincolo de ceea ce el este capabil să facă ca un singur întreținător.

Și astăzi – exact la 5 ani după ce Thibaut a creat DevDocs – sunt încântat să anunț asta DevDocs face acum parte oficial din comunitatea Routech!

O scurtă istorie a DevDocs

Thibaut este un dezvoltator francez care lucrează acum ca lider de dezvoltare senior la Shopify din Ottawa, Canada.

Thibaut a creat DevDocs acum exact acum 5 ani, pe 26 martie 2013. În acel moment, el dorea doar o modalitate mai bună de a accesa rapid documentația rețelei de dezvoltatori Mozilla.

Inițial, DevDocs era doar un dosar obișnuit de documentare pe hard diskul său, pentru uz personal – genul pe care mulți dezvoltatori îl aveau la îndemână pentru referință. Apoi, după câteva luni de dezvoltare, Thibaut a lansat DevDocs pe 18 iunie 2013, ca aplicație web gratuită.

La început, Thibaut a ținut DevDocs sursă închisă. Dar pe 24 octombrie 2013, el a deschis-o sursă.

Proiectul DevDocs a acumulat de atunci peste 17.000 de stele GitHub, împreună cu 66 de colaboratori (deși Thibaut este de departe cel mai prolific contribuitor al său).

1611456008 305 DevDocs se alatura comunitatii Routech

Thibaut a scris zeci de scripturi de răzuire pentru a ieși și a descărca automat documentația din diferite proiecte, fiecare reglată cu atenție pentru a crea o experiență de lectură consistentă și pentru a genera rezultate bune de căutare.

În următorii doi ani, Thibaut a adăugat multe îmbunătățiri, cum ar fi documentația nouă, comenzile rapide de la tastatură, o căutare mai bună, asistență mobilă și posibilitatea de a trece la o temă întunecată pentru vizionarea pe timp de noapte.

Apoi, în 2015, Thibaut a făcut DevDocs complet funcțional offline. Dintr-o dată, oricine ar putea descărca seturi întregi de documentație pentru acces offline. Toate aceste fișiere ar fi stocate în browser, datorită utilizării inteligente a unei noi tehnologii numită IndexedDB.

Și la începutul anului 2016, Thibaut a adăugat suport pentru versiuni. În loc să fie limitat doar la cea mai recentă versiune a unei documentații, DevDocs a început acum să accepte mai multe versiuni pentru fiecare proiect și bibliotecă.

Aceste două noi caracteristici majore s-ar dovedi a fi un punct de inflexiune în baza de utilizatori DevDocs. Proiectul a devenit unul dintre cele mai utilizate instrumente din comunitatea de dezvoltatori.

1611456009 54 DevDocs se alatura comunitatii Routech
Preferințele modului offline DevDocs, văzute aici cu modul întunecat activat.

Dacă doriți să vedeți cât de departe a ajuns DevDocs în ultimii cinci ani, comparați aceste două fire de știri Hacker:

  1. Primul fir din iunie 2013 – majoritatea oamenilor compară în mod nefavorabil DevDocs cu alte proiecte de documentare (dintre care multe sunt acum defecte).
  2. Un al doilea fir de la sfârșitul anului 2017 – într-unul dintre cele mai apreciate fire din toate timpurile Hacker News, oamenii laudă DevDocs – în special pentru viteza sa. Mesajul este clar: proiectul tău nu trebuie să fie primul de acest gen – trebuie doar să rămâi cu el și să-i aduci îmbunătățiri consistente și poți să devii lider.

Astăzi, peste 100.000 de dezvoltatori folosesc DevDocs ca referință în fiecare lună.

Cum funcționează DevDocs sub capotă

Una dintre cele mai frecvente întrebări pe care oamenii le pun lui Thibaut: cum a ajuns DevDocs să fie atât de rapid?

Thibaut atribuie viteza DevDocs multor factori:

  • DevDocs este o aplicație web Ruby cu o singură pagină, cu un backend mic.
  • Când vizitați DevDocs.io, după încărcarea inițială a paginii, toate fișierele ulterioare (inclusiv fișierele de documentare) sunt preluate printr-o rețea rapidă de livrare a conținutului (CDN).
  • Folosește GZIP, cache HTTP, cache de aplicații, JavaScript și CSS concatenate și minimizate
  • Nu există anunțuri (anunțurile încetinesc totul)
  • Utilizează localStorage ca un nivel suplimentar de stocare în cache pentru unele active
  • Folosește un cache în memorie pentru lucruri precum navigarea instantanee înapoi și înainte
  • Folosește IndexedDB pentru stocarea în cache a seturilor întregi de documentație la nivel local pe computer
  • Documentația este eliminată de toate activele la distanță și de marcarea inutilă, rezultând fișiere mai mici
  • Folosește căutare optimizată din partea clientului
  • Are o interfață de utilizator non-blocantă și asincronă
  • Dispune de un arbore DOM optimizat cu un paginat lista barei laterale, astfel încât să nu fie necesară redarea imediată a 1.000 de noduri
  • Are o interfață de utilizator simplă, care evită florile, cum ar fi umbrele sau animațiile

În cele din urmă, DevDocs nu folosește niciun jQuery sau niciun cadru JavaScript. Toate operațiunile DOM sunt implementate manual, făcându-le cât mai repede posibil. (Thibaut spune că nu ar recomanda această abordare fără cadru pentru majoritatea aplicațiilor, dar funcționează bine pentru DevDocs.)

Cum vă puteți implica

În acest moment, căutăm un dezvoltator pasionat și experimentat Ruby, care este interesat să devină un colaborator pe termen lung la DevDocs.

Căutăm, de asemenea, persoane interesate să faciliteze contribuția DevDocs, prin scrierea documentației și codul refactorizării.

De asemenea, puteți ajuta raportând orice erori sau cereri de caracteristici pe care le aveți în urmăritorul de probleme, și ajutând la triere sau remedierea acestora.

Poți să te alături sala de chat pentru colaboratori DevDocs pe Gitter și prezintă-te.

În cele din urmă, puteți ajuta utilizând DevDocs și partajându-l cu prietenii și colegii. Data viitoare când trebuie să căutați documentație, accesați DevDocs.io.

De asemenea, puteți căuta în DevDocs tastând „devdocs” în bara de adrese a Chrome și apăsând fila. Și DuckDuckGo are un special !dd comanda pentru a căuta și în DevDocs.

Alătură-te mie pentru a-i întâmpina pe Thibaut și DevDocs în comunitatea Routech de către tweeting la el.

Distrați-vă și codificați fericit!