Dokumentacija

Dokumentacija pisana za ljude, ne samo za strojeve

Od prvog koraka do naprednih konfiguracija — sve je objašnjeno primjerima iz stvarnog života, ne apstraktnim pseudokodom.

Prikaz stranice dokumentacije s bočnom navigacijom i primjerima koda

Što pokrivaš dokumentacijom?

Gardenpathm dokumentacija obuhvaća sve: od vodiča za početak rada (onboarding guide) i konfiguracije prvih integracija, do referentnog pregleda svih API endpoint-a s primjerima zahtjeva i odgovora. Svaki vodič dolazi u dvije varijante — kratka verzija za one koji žele brzo pokrenuti sustav, i detaljna verzija s objašnjenjima arhitekturalnih odluka za one koji žele razumjeti što se događa ispod haube. Dokumentacija se ažurira uz svaki release i sadrži changelog koji jasno označava što je novo, što je promijenjeno i što je zastarjelo.

Što uključuje naša dokumentacija

Vodiči za početnike

Strukturirani put od nule do prvog radnog dashboarda u manje od jednog sata. Svaki korak uključuje screenshot sučelja i primjer stvarnih podataka iz e-commerce konteksta.

API referenca

Svaki endpoint dokumentiran s primjerom zahtjeva, primjerom odgovora, opisom svakog polja i popisom mogućih grešaka — dostupno u interaktivnom i statičnom formatu.

Video tutoriali

Biblioteka od 24 kratka video tutoriala (3 do 8 minuta svaki) pokriva najčešće scenarije: postavljanje alarma, kreiranje prilagođenih dashboarda i exportanje podataka.

Redovite izmjene

Dokumentacija se ažurira uz svaki sprint (svaka dva tjedna). Changelog je dostupan kao RSS feed i putem e-mail pretplate, tako da uvijek znaš što se promijenilo.

„Dokumentacija je bila toliko dobra da sam mlađem kolegi jednostavno poslala link i rekla mu neka implementira API integraciju. Nije me zvao ni jednom. Sve je bilo tu, jasno i s primjerima koji su zapravo radili.”

Ana Blažević, CTO, Pulso d.o.o., Zagreb

Pitanja o dokumentaciji i podršci

Je li dokumentacija dostupna na engleskom?

Da. Cijela dokumentacija postoji na hrvatskom i engleskom jeziku. Korisnici mogu prebaciti jezik u bilo kojoj točki čitanja bez gubitka konteksta — stranice su parovi prijevoda, ne zasebni dokumenti.

Mogu li predložiti poboljšanja dokumentacije?

Svakako. Svaka stranica dokumentacije ima gumb za povratnu informaciju i mogućnost direktnog otvaranja GitHub issue-a. Sve prijave pregledavamo unutar tjedan dana i nagrađujemo kvalitetne prijedloge produljenjem pretplate.

Postoji li offline verzija dokumentacije?

Da, cijela dokumentacija može se preuzeti kao PDF ili zip arhiva s HTML datotekama. Korisno za rad bez interneta ili za internu distribuciju unutar tvrtke.

Pitanje na koje nisi našao odgovor?

Naš tim odgovara na tehničke upite unutar jednog radnog dana.

Kontaktiraj podršku