Toteutusta varten
Dokumentaation tulisi auttaa tiimejä ymmärtämään käyttöönottojärjestys, tietorakenne, ostajien käyttöoikeudet ja päivittäiset toimintarutiinit.
Dokumentaatio
BrandGate-dokumentaatio tiimeille ja kehittäjille
Referenssimateriaalia käyttöönottoon, tuotteisiin, jakelijoihin, tilauksiin, laskutukseen, verkkokauppoihin, tilausten käsittelyyn, integraatioihin ja kehittäjien työnkulkuin.
Teknistä siirtymää varten
Kehittäjille suunnatut muistiinpanot tukevat rajapintaa, integraatioita, vientejä ja turvallista käyttöönoton suunnittelua.
Käyttöönotto
Yrityksen määrittäminen, tiimin käyttöoikeudet, tuotteiden tuonti, jakelijakutsut ja ensimmäisen tilauksen vaiheet.
Toiminnot
Tuotteet, tilaukset, laskut, tilausten käsittely, raportit, asetukset ja tarkastuskelpoiset työnkulut.
Verkkokauppa
Kaupan editori, brändäys, sivut, julkaisu, julkaistu kauppa, kassa ja ostajan tilin osiot.
Kehittäjän huomiot
API-käsitteet, integraatiot, viennit, webhook-tyyppiset työnkulut ja toteutuksen suunnittelu.
Dokumentaatio
Dokumentaation tulee kertoa, mitä tehdä seuraavaksi
Selkeä dokumentaatio vähentää tukitarpeita ja tekee tuotteesta valmiimman.
Käyttöönoton järjestys
Tiimien on tiedettävä, mitkä asetukset tulee tehdä ensin.
Roolien erottelu
Ylläpitäjän, ostajan, taloushallinnon, tilausten käsittelyn ja kehittäjän tehtävien on oltava erotettavissa.
Turvallinen testaus
Dokumentaation tulisi kertoa, milloin toimenpide voi vaikuttaa todellisiin ostajiin tai ulkoisiin järjestelmiin.
Vianmääritys
Yleisimmät tyhjät, yhteydettömät ja validointitilat tarvitsevat käytännönläheiset ohjeet.
Dokumentaatio
Dokumentaatiokartta
Aloita käyttöönotosta ja siirry sitten alueeseen, jota olet määrittämässä tai testaamassa.
01
Määritä työtila
Yritys, tiimi, tuoteluettelo, jakelijapääsy ja kaupan asetukset.
02
Suorita työnkulkuja
Tilaukset, laskut, raportit, tilausten käsittely, ostajan kassa ja verkkokaupan julkaisu.
03
Yhdistä järjestelmät
Maksut, kirjanpito, verkkotunnukset, API, viennit ja tukesiirto.
Dokumentaatio eri kohderyhmille
BrandGate-dokumentaation tulee palvella sekä käyttäjiä että kehittäjiä.
Liiketoimintakäyttäjät
Selkeät ohjeet tuotteen työnkulkuun.
Järjestelmänvalvojat
Ohjeet määrityksiin, käyttöoikeuksiin ja asetuksiin.
Kehittäjät
Integraatiokonseptit ja toteutuksen turvarajat.
Dokumentaation kysymykset
Onko dokumentaatio saatavilla ruotsiksi?
Julkiset dokumentaatioreitit on valmisteltu ruotsiksi ja englanniksi paikallisen i18n-rakenteen kautta.
Mistä löydän API-tiedot?
Aloita API-sivulta ja ota sitten yhteyttä BrandGateen pääsyoikeuksien tai räätälöidyn integraation suunnittelua varten.
Kattavatko ohjeet oman työnkulkuni?
Lähetä meille työnkulku, niin etsimme oikean tukikanavan tai ohjeistuksen.
Tarvitsetko apua oikean ohjeen löytämisessä?
Lähetä kuvaus työnkulusta, jota olet rakentamassa, niin ohjaamme sinut oikeaan paikkaan.
Ota yhteyttä tukeen