De la lansarea inițială în 2021, platforma noastră R-Universe a devenit constant într-o infrastructură cuprinzătoare pentru publicarea și descoperirea materialelor R. Pe măsură ce funcționalitatea continuă să evolueze și să crească adopția comunității, am considerat că este nevoie de un punct central de documentare.
Noile caracteristici și evoluții sunt discutate în general în The Editoment Tracker sau Comitet de discuții și uneori pe blogul Ropensci. Detalii tehnice pot fi găsite în fișierele Readme și în codul sursă al depozitelor respective de sub R-Universe-Org care conțin toate fluxurile de lucru, acțiunile și codul serverului (sistemul R-Universe este în întregime open source). Această fragmentare poate îngreuna găsirea informațiilor actualizate, în special pentru utilizatorii noi.
Datorită finanțării de către Google Sezonul Docs, am putut începe un nou proiect de documentare cuprinzător pentru toți utilizatorii și dezvoltatorii R-Universe. Am stabilit un loc central în care colectăm diferitele surse de informații și descriem exemple și cazuri de utilizare, folosind instrumente populare de autor pentru a sprijini întreținerea colectivă.
Noile documente R-Universe
Am creat -o ca o carte de quarto, deoarece acesta este un format comun pe care mulți membri ai comunității R sunt obișnuiți să le citească (de exemplu în pachetele R, R pentru știința datelor, Ghidul nostru de dezvoltare) și poate contribui la.
Documentația este organizată în prezent în patru secțiuni principale:
- Căutați care documentează experiența utilizatorului navigând pachete și universuri.
- Instala Asta explică modul de instalare a pachetelor de la R-Universe, cum să vă asigurați reproductibilitatea și cum să creați o dependență de un pachet publicat pe R-Universe.
- Publica Acest lucru se concentrează pe experiența dezvoltatorului de pachete: de ce și cum să publicați pachete.
- Infrastructurădocumentarea guvernării, finanțării și modul în care R-Universe funcționează sub capotă pentru cei care doresc să contribuie. (O lucrare în curs!)
Suntem recunoscători pentru recenzorii de documentație Lluís Revilla și Yaoxiang Li, care au oferit feedback -uri interesante care ne -au ajutat să îmbunătățim versiunea inițială a site -ului.
Tur interactiv al site -ului web
Pe lângă un nou site DOCS, am adăugat și unele încorporat Documentare pe site -ul web: Fiecare pagină de pachete are un buton „Turul site -ului” în Navbar, care vă ghidează prin toate informațiile afișate pe pagină. Du -te să încerci!
O experiență de documente simplificate
În timp ce lucram la documentație, am actualizat și alte surse de informații:
Am simplificat pagina proiectului R-Universe de pe site-ul Ropensci, să fie mai ușor de întreținut. Acum conține o descriere cu imagini mari a proiectului, precum și link-uri către resurse relevante, inclusiv site-ul de documentare, note tehnice, înregistrări recente de discuții. Această pagină web este disponibilă și în spaniolă.
Concluzie
Noul proiect Docs va deveni locul central în care menținem informații actualizate pentru utilizatori și dezvoltatori de R-Universe. Versiunea inițială a site -ului are cele mai importante biți, dar este departe de a fi completă. La fel ca R-Universe în sine, documentația este un proiect viu care trebuie să crească iterativ pe baza nevoilor și contribuțiilor dvs.
Dacă ați folosit R-Universe într-un fel sau altul și aveți idei despre cum ar putea fi îmbunătățită documentația, vă salutăm contribuțiile.
