Gdje je dokumentacija i kako se koristi?
Dokumentacija je dio same aplikacije, a ne odvojeni wiki ili vanjski sustav. To znači da je uvijek dostupna u istoj verziji kao i dućan, da ne ovisi o vanjskim servisima koji mogu pasti i da radi čak i kad trgovčeva tema ili CMS nije dostupan.
Pomoć na hrvatskom adresirana po slugu
Sve stranice pomoći nalaze se na adresama oblika /pomoc/{slug}. Prazan slug (/pomoc) vodi na naslovnu stranicu pomoći. Stranice su pisane na hrvatskom i namijenjene trgovcu, a ne programeru. Umjesto da pretražuje repozitorij ili traži PDF, trgovac unutar platforme klikne poveznicu i dobije objašnjenje za točnu temu. Na primjer, stranica /pomoc/paketi objašnjava pakete, /pomoc/narudzbe objašnjava rad s narudžbama, a /pomoc/postavke vodi kroz postavke dućana.
Broj stranica, slika i videa koji raste s platformom
Trenutno dokumentacija sadrži više od 40 stranica pomoći, desetke video walkthrougha po administracijskim ekranima i preko stotinu slikovnih datoteka s anotacijama. Slike pokrivaju gotovo svaki ekran administracije i dućana, uključujući izgled e-mailova, mobilne ekrane, stanja kvote i upsell ekrane.
Video walkthroughi pružaju snimljene prolaze kroz ključne tokove, poput onboardinga, kupovine, kartičnog plaćanja, mobilne kupovine, ciklusa povrata i promjene teme. Ovaj broj nije fiksiran izvan codebasea. Dokumentacija se nadograđuje istovremeno s razvojem značajki.
Ugrađena u binarij, a ne datoteka na disku
Sav sadržaj pomoći (tekstualne stranice, slike i video) ugrađen je izravno u binarij aplikacije. To znači da deploy ne mora prenositi zasebne datoteke, dokumentacija nikad ne curi na pogrešnu verziju i ne ovisi o vanjskim CDN-ovima.
Svaka nova verzija platforme donosi i odgovarajuću verziju dokumentacije, pa upute ne mogu zastarjeti u odnosu na kôd. Trgovac uvijek čita dokumentaciju koja odgovara točno onoj inačici koju trenutno koristi.
Zasebni minimalni layout
Stranice pomoći koriste vlastiti minimalni HTML layout, odvojen od enginea za teme trgovca. Ako trgovac slučajno pokvari predložak ili stilove svog dućana, stranica pomoći i dalje ostaje čitljiva. Isto vrijedi i za situacije kad CMS nije dostupan iz drugih razloga. Pomoć radi neovisno o stanju pojedinog dućana. Time je dokumentacija dostupna i u trenucima kad drugi dio sučelja zakaže.
Brzo serviranje uz keširanje
Sadržaj se renderira iz markdowna u HTML samo jednom po pokretanju procesa, a zatim drži u memorijskom kešu. Time su stranice uvijek brzo dostupne, bez obzira koliko je trenutno opterećenje na platformi. Keš se ponovno puni tek nakon restarta aplikacije, što je sukladno činjenici da se sadržaj ugrađuje u binarij. Kupac ili trgovac ne čeka renderiranje pri svakom učitavanju stranice.
Zaštita od pristupa izvan predviđenog puta
Sistem provjerava slug stranice, kao i imena slika i videa, prije bilo kakvog čitanja. Dopušteni su samo mala slova, znamenke, crtice i kosa crta za segmente, a segmenti poput točke, dvije točke ili prazni segmenti se odbijaju.
Isto tako imena slika i videa moraju završavati na dopuštene ekstenzije i sadržavati samo sigurne znakove. To sprječava pokušaje pristupa datotekama izvan predviđenog direktorija. Slike i video se ne mogu tražiti proizvoljnim putanjama, već isključivo po imenima koje su dio ugrađenog sadržaja.
Video podržava premotavanje
Video walkthroughi se serviraju iz binarija uz odgovarajuće zaglavlje za HTTP Range zahtjeve. To znači da preglednik može zatražiti samo dio datoteke umjesto cijele, pa korisnik može premotavati video bez da prethodno mora preuzeti cijelu snimku. Player započinje reprodukciju odmah nakon prvog klikanja, a prijelaz na proizvoljnu točku u videu radi bez čekanja.
Poveznice s ostalih mjesta platforme
Stranica uspjeha nakon registracije odmah upućuje trgovca na pomoć, a landing stranica i podnožje marketinških stranica sadrže poveznicu na /pomoc. Time trgovac nikad nije daleko od uputa, bilo da tek otvara dućan ili traži pojašnjenje neke značajke. Pomoć nije skriveni dodatak, već vidljiv dio platforme kojem se može pristupiti iz više točaka.
Zaključak
Dokumentacija je zamišljena kao prvorazredni dio proizvoda, a ne tehnička napomena. Nalazi se unutar same aplikacije, verzionira se zajedno s njom, radi neovisno o stanju dućana i sadrži kombinaciju teksta, slika i videa. Time trgovac može sam pronaći odgovore na najčešća pitanja bez oslanjanja na podršku.
Više o temi: Paketi i početak.
Česta pitanja.
Moram li kontaktirati podršku da bih naučio koristiti WebShopHR?
Ne nužno. Dokumentacija je ugrađena u samu aplikaciju na /pomoc/{slug}, na hrvatskom, s tekstom, slikama i video walkthroughima za većinu ekrana. Često je brže otvoriti pomoć nego čekati odgovor podrške.
Radi li dokumentacija i kad je moj dućan ili CMS u kvaru?
Da. Stranice pomoći koriste vlastiti minimalni layout, odvojen od enginea za teme trgovca, pa ostaju čitljive čak i ako trgovac pokvari svoj predložak ili CMS iz nekog razloga nije dostupan.
Hoće li upute u dokumentaciji zastarjeti u odnosu na stvarnu verziju aplikacije koju koristim?
Ne bi trebale. Sadržaj pomoći ugrađen je izravno u binarij i verzionira se zajedno s kodom. Svaka nova verzija platforme nosi i odgovarajuću verziju dokumentacije.
Mogu li premotati video upute umjesto da gledam sve od početka?
Da. Video walkthroughi podržavaju HTTP Range zahtjeve, pa preglednik može zatražiti samo dio datoteke i premotati na proizvoljnu točku bez čekanja na preuzimanje cijele snimke.
Gdje nađem poveznicu na pomoć ako sam tek registrirao dućan?
Stranica uspjeha nakon registracije odmah upućuje na pomoć, a poveznica /pomoc stoji i u podnožju marketinških stranica. Dokumentacija nije skrivena, dostupna je s više mjesta platforme.