CMS in API

Vodnik po pripomočkih za spletno mesto.

Uporabite pripomoček, ko je hitra uvedba pomembna in lahko spletno mesto zagotovi trajne izvorne identifikatorje in dostopno jezikovno navigacijo.

Pojasnite nalogo in odločitev

Ta priročnik spremeni vodnik po pripomočkih spletnega mesta v potek dela, ki ga je mogoče pregledati. Povezuje domenske odločitve, lastništvo, dokaze in sprejemanje, tako da rezultat še naprej deluje v proizvodnji.

Uporabite pripomoček, ko je hitra uvedba pomembna in lahko spletno mesto zagotovi trajne izvorne identifikatorje in dostopno jezikovno navigacijo.

Praktični postopek

  1. 1

    Vrste virov inventarja, identifikatorji, polja, lokalne nastavitve, lastniki in stanja objave.

  2. 2

    Izberite vzorec dostave med glasnostjo, zakasnitvijo, uredniškim nadzorom in toleranco napak.

  3. 3

    Preslikaj izvorni zapis v ločen zapis jezikovne različice s trajno povezavo.

  4. 4

    Dodajte preverjanje pristnosti, idempotenco, ponovni poskus, razveljavitev predpomnilnika, beleženje in nadzor dostopa.

  5. 5

    Preskusna objava, spremembe vira, nerazpoložljivi rezultati, povrnitev nazaj, delovanje tipkovnice in spremljanje pred izdajo.

Primer ali orodje

Vzorec uvajanja zajema nalaganje, nerazpoložljive različice, upravljanje fokusa, analitiko in vedenje brez skripta. V orodju zabeležite tudi izhodišče, lastnika, odločitev, dokaze, odprto vprašanje in datum odobritve. Uporabite pravo stran ali transakcijo, da bo skupina videla odvisnosti, izjeme in vzdrževalna dela, ki sledijo izdaji.

Točka odločitveZapisKriterij sprejemljivosti
IzhodiščeOpaženo trenutno stanjeVir in datum zapisa
OdločitevIzbrana možnost in utemeljitevUpoštevano je tveganje in občinstvo
DokaziPreizkusite, dokumentirajte ali izmeritePregledljiv in specifičen za različico
OdobritevIme, vloga in datumIzpolnjeni vsi obvezni kriteriji

Potrdite, da je pripomoček pravi vzorec dostave

Pripomoček je primeren, če lahko gostiteljsko mesto zagotovi stabilne izvorne identifikatorje, strani imajo predvidljivo strukturo vsebine, pomembna je hitra uvedba in je sprejemljiva izboljšava na strani odjemalca. Manj primeren je, kadar morajo biti nadomestne različice v celoti indeksirane, morajo delovati pod strogimi omejitvami skripta ali pripadajo zapletenemu potrjenemu potovanju. V teh primerih strežniško upodobljene strani ali integracija CMS zagotavljajo močnejši nadzor.

Izpolnite kratek zapis odločitve o arhitekturi, ki zajema lastništvo vsebine, podatke, poslane storitvi, gostovanje skriptov, posledice soglasja, varnostno politiko vsebine, proračun za zmogljivost, podporo brskalnika, dostopnost, vedenje pri iskanju, analitiko, stanje napake in odgovornost za vzdrževanje. Pripomoček mora izboljšati stran in ne postati edina pot do bistvenih informacij. Prvotna storitev ostane uporabna, ko je skript blokiran, počasen ali ni na voljo.

MeriloDobro prileganje pripomočkaRaje dostava na strani strežnika
ZagonNadzorovano mesto potrebuje hiter dodatekPotreben je globok potek dela CMS in nadzor sprostitve
OdkritjeVir je jasno povezan z izboljšano različicoNadomestna stran potrebuje neodvisno iskalno indeksiranje
OdpornostVir ostaja popolna rezervaNadomestna različica je nujna za dokončanje naloge
VarnostOdobren pravilnik o prileganju skripta in pretoka podatkov spletnemu mestuStroge omejitve skripta ali overjenega konteksta

Postopno nalaganje in zaščito delovanja strani

Postrezite nalagalnik z majhnimi različicami iz odobrenega izvora s Subresource Integrity, kjer to podpira model uvedbe. Naložite ga z odlogom, inicializirajte šele, ko ustrezni vsebnik obstaja, in se izogibajte blokiranju primarne vsebine. Gostitelj zagotavlja stabilen ID strani, izvorno revizijo, področne nastavitve in dovoljene jezikovne načine prek potrjene konfiguracije. V atribute podatkov nikoli ne postavljajte poverilnic API, osebnih podatkov ali neomejenega HTML-ja.

Rezervirajte prostor postavitve za kontrolnike ali jih vstavite, ne da bi premaknili glavni naslov in vsebino opravila. Nastavite proračune uspešnosti za velikost skripta, število zahtev in zakasnitev interakcije. Prekini po določeni časovni omejitvi in ​​odstrani indikatorje nalaganja. Predpomni le odobrene javne rezultate, ki jih ključi glede na izvorno revizijo in način. Pozen ali neuspešen gradnik ne skrije, podvoji ali zamenja izvorne strani.

  1. 1

    Blizu naslova strani dodajte semantično povezavo, upodobljeno s strežnikom, ali kontrolnik.

  2. 2

    Naložite skript z različico brez blokiranja izvorne vsebine.

  3. 3

    Preverite konfiguracijo gostitelja in zahtevajte samo odobreno javno različico.

  4. 4

    Upodabljanje kontrolnikov in vsebine z izvorno semantiko in predvidljivim fokusom.

  5. 5

    Poročajte o stanju delovanja brez pošiljanja nepotrebne vsebine strani ali uporabniških podatkov.

Oblikovanje navigacije in vsako stanje napake

Uporabite običajno povezavo, če ima jezikovna različica svoj naslov. Če se vsebina spremeni na mestu, uporabite gumb, ki poimenuje ciljni način, po potrebi posodobi naslov dokumenta in glavni naslov, premakne fokus le, ko je uporabnik sprožil spremembo, in napove dokončanje prek jedrnatega sporočila o stanju. Ohranite zgodovino brskalnika in zagotovite jasno pot nazaj do izvirnika. Preizkusite povečavo, reflow, tipkovnico, bralnik zaslona, ​​visok kontrast, zmanjšano gibanje in prevedene oznake.

Določite stanja za nerazpoložljivo različico, časovno omejitev zahteve, neveljavno konfiguracijo, blokiran skript, nepodprt brskalnik in servisno vzdrževanje. Vsako stanje ohrani vir in ponudi varno naslednje dejanje. Ne prikažite trajnega vrtilnika, prazne plošče, neobdelane kode napake ali kontrolnika, za katerega je videti, da deluje, vendar pušča vsebino nespremenjeno. Ko je JavaScript onemogočen, vir, ki ga upodablja strežnik, in vse znane povezave nadomestne strani ostanejo na voljo.

  • Izvorno potovanje ostane dokončano, ko se pripomoček nikoli ne naloži.

  • Kontrolniki uporabljajo izvorne povezave ali gumbe z odobrenimi imeni jezikovnega načina.

  • Sporočila o fokusu in stanju so predvidljiva in niso vsiljiva.

  • Vsaka časovna omejitev in stanje nedosegljivosti ima varno naslednje dejanje.

  • Noben analitični ali diagnostični dogodek ne vsebuje besedila strani ali osebnih podatkov po nepotrebnem.

Preizkusite gostiteljsko okolje in spremljajte dejansko dostavo

Preizkusite reprezentativne predloge, prekinitvene točke, brskalnike, stanja privolitve, omrežne hitrosti, pravilnike o varnosti vsebine, upravitelje oznak in podporne tehnologije. Vključuje ponavljajočo se inicializacijo, navigacijo na strani odjemalca, dinamično vstavljeno vsebino, tiskanje, oznake prevodov, potek predpomnilnika, nerazpoložljiv rezultat, časovno omejitev in blokirano zahtevo tretjih oseb. Prepričajte se, da pripomoček ne ustvari podvojenih ID-jev, neveljavnega vrstnega reda naslovov, pasti fokusa, premika postavitve ali nasprotujočih si globalnih slogov.

Spremljajte uspešnost nalaganja, razpoložljivost različice, odzivni čas, izjeme upodabljanja, zastarele revizije vira in izbiro načina, ki ga sproži uporabnik. Vzorec po gostiteljski predlogi in različici skripta, ne po osebni identiteti. Določite lastnika, opozorilni prag, različico za povrnitev in komunikacijski proces gostitelja. Izdaja je sprejeta, ko vir ostane uporaben ob vsaki simulirani napaki, kritične naloge delujejo s tipkovnico in bralnikom zaslona in je mogoče obnoviti prejšnjo različico skripta brez sprememb gostiteljske strani.

Vloge, dokazi in odobritev

Generiranje naj bo ločeno od objave. Uspešen odgovor je osnutek, ne odobritev. Shranite izvorni identifikator in različico, nastavitve transformacije, identifikator rezultata, stanje pregleda, odobritelja in čas objave. Ko se vir spremeni, označite jezikovno različico za pregled, namesto da tiho zamenjate odobreno vsebino. To omogoča povrnitev in revizijo na vseh platformah.

Delovanje in vzdrževanje

Delo se ne konča z objavo. Povežite jezikovno različico ali konfiguracijo z njenim izvorom, spremljajte ukrepe kakovosti in storitev ter definirajte konkretne sprožilce pregleda. Sprožilci vključujejo spremembe vira, pravne spremembe, nove potrebe občinstva, ponavljajoča se vprašanja podpore, tehnične spremembe in incidente. Imenovani lastnik oceni sprožilec, po potrebi odpre novo revizijo in zabeleži ponovno odobritev.

Kontrolni seznam za objavo

  • Integracija uporablja trajne izvorne identifikatorje.

  • Poverilnice so shranjene na strani strežnika in se izmenjujejo.

  • Določeni so časovna omejitev, ponovni poskus in omejitev hitrosti.

  • Ponavljajoče se zahteve so idempotentne.

  • Ustvarjena vsebina preide v stanje pregleda.

  • Spremembe vira razveljavijo ali znova odprejo različico.

  • Jezikovna navigacija deluje s pomočjo tipkovnice in podporne tehnologije.

  • Spremljanje zajema napake, čakalne vrste, zakasnitev in zastarelo vsebino.

Verodostojni viri

  1. Dokumentacija Simple8 API
  2. Simple8 vzorci dostave
  3. Smernice za dostopnost spletne vsebine (WCAG) 2.2

Uporabite vodnik v praksi

Preizkusite Simple8 z reprezentativno vsebino in uporabite kontrolni seznam za načrtovanje nadzorovanega delovnega toka proizvodnje.

Preizkusite svoje besedilo