CMS ja API

Veebisaidi vidinate juhend.

Kasutage vidinat, kui kiire juurutamine on oluline ja sait võib pakkuda püsivaid allika identifikaatoreid ja juurdepääsetavat keelelist navigeerimist.

Selgitage ülesanne ja otsus

See juhend muudab veebisaidi vidinate juhendi ülevaatavaks töövooks. See ühendab domeeniotsused, omandiõiguse, tõendid ja aktsepteerimise, nii et tulemus töötab tootmises edasi.

Kasutage vidinat, kui kiire juurutamine on oluline ja sait võib pakkuda püsivaid allika identifikaatoreid ja juurdepääsetavat keelelist navigeerimist.

Praktiline töövoog

  1. 1

    Varude allika tüübid, identifikaatorid, väljad, lokaadid, omanikud ja avaldamise olekud.

  2. 2

    Valige tarnemuster helitugevuse, latentsuse, toimetuse juhtimise ja tõrketaluvuse hulgast.

  3. 3

    Vastandage lähtekirje püsiva sidemega eraldi keeleversiooni kirjega.

  4. 4

    Lisage autentimine, idempotentsus, uuesti proovimine, vahemälu kehtetuks tunnistamine, logimine ja juurdepääsu juhtelemendid.

  5. 5

    Testi avaldamine, allika muudatused, kättesaamatud tulemused, tagasipööramine, klaviatuuri kasutamine ja jälgimine enne avaldamist.

Näide või tööriist

Juurutusmuster hõlmab laadimist, kättesaamatud versioone, fookuse haldamist, analüütikat ja skriptivaba käitumist. Tööriistas registreerige ka lähteseisund, omanik, otsus, tõendid, avatud probleem ja kinnitamise kuupäev. Kasutage päris lehte või tehingut, et meeskond näeks sõltuvusi, erandeid ja väljalaskmisele järgnevat hooldustööd.

OtsustuspunktSalvestusVastuvõtmise kriteerium
LähtejoonTäheldatud hetkeseisuAllikas ja salvestamise kuupäev
OtsusValitud variant ja põhjendusArvestatud on riski ja publikuga
TõendidTestige, dokumenteerige või mõõtkeÜlevaatav ja versioonipõhine
HeakskiitNimi, roll ja kuupäevKõik kohustuslikud kriteeriumid on täidetud

Veenduge, et vidin on õige tarnemuster

Vidin sobib siis, kui hostsait suudab pakkuda stabiilseid allika identifikaatoreid, lehtedel on etteaimatav sisustruktuur, kiire juurutamine on oluline ja kliendipoolne täiustamine on vastuvõetav. See on vähem sobiv, kui alternatiivsed versioonid peavad olema täielikult indekseeritud, peavad töötama rangete skriptipiirangutega või kuuluma keerukasse autentitud teekonda. Sellistel juhtudel pakuvad serveris renderdatud lehed või CMS integratsioon tugevamat kontrolli.

Täitke lühike arhitektuuriotsuse kirje, mis hõlmab sisu omandiõigust, teenusele saadetud andmeid, skripti hostimist, nõusoleku mõju, sisu turbepoliitikat, jõudluseelarvet, brauseri tuge, juurdepääsetavust, otsingukäitumist, analüüsi, tõrkeolekut ja hooldusvastutust. Vidin peab lehte täiustama, mitte muutuma ainsaks olulise teabe teekonnaks. Algne teenus jääb kasutatavaks, kui skript on blokeeritud, aeglane või kättesaamatu.

KriteeriumHea vidina sobivusEelista serveripoolset kohaletoimetamist
KäivitageKontrollitud sait vajab kiiret lisamistVajalik on sügav CMS töövoog ja vabastamise juhtimine
AvastusAllikas viitab selgelt täiustatud versioonileAlternatiivne leht vajab sõltumatut otsingu indekseerimist
VastupidavusAllikas jääb täielikuks tagavaraksÜlesande täitmiseks on oluline alternatiivne versioon
TurvalisusKinnitatud skripti ja andmevoo saidi sobivuse eeskirjadRanged skripti või autentitud konteksti piirangud

Laadige järk-järgult ja kaitske lehe jõudlust

Esitage heakskiidetud päritolu väikese versiooniga laadurit koos alamressursi terviklikkusega, kui juurutusmudel seda toetab. Laadige see edasilükkamisega, lähtestage alles pärast vastava konteineri olemasolu ja vältige peamise sisu blokeerimist. Host pakub kinnitatud konfiguratsiooni kaudu stabiilse lehe ID, allika versiooni, lokaadi ja lubatud keelerežiimid. Ärge kunagi asetage andmeatribuutidesse API mandaate, isikuandmeid ega piiramatut HTML-i.

Reserveerige juhtelementide paigutusruumi või sisestage need ilma peamist pealkirja ja ülesande sisu nihutamata. Määrake jõudluseelarved skripti suuruse, taotluste arvu ja interaktsiooni viivituse jaoks. Katkestage pärast määratud ajalõpu ja eemaldage laadimisindikaatorid. Vahemällu ainult heakskiidetud avalikud tulemused, sisestades need allika versiooni ja režiimi järgi. Hilinenud või ebaõnnestunud vidin ei peida, dubleeri ega asenda lähtelehte.

  1. 1

    Lisage lehe päise lähedusse semantiline serveri renderdatud link või juhtkohatäide.

  2. 2

    Laadige versiooniga skript ilma lähtesisu blokeerimata.

  3. 3

    Kinnitage hosti konfiguratsioon ja taotlege ainult heakskiidetud avalikku versiooni.

  4. 4

    Renderdage juhtelemente ja sisu natiivse semantika ja prognoositava fookusega.

  5. 5

    Teatage tööolekust ilma tarbetut lehe sisu või kasutajaandmeid saatmata.

Kujundage navigeerimist ja iga rikkeseisundit

Kasutage tavalist linki, kui keeleversioonil on oma aadress. Kui sisu paigas muutub, kasutage nuppu, mis nimetab sihtrežiimi, värskendab vastavalt vajadusele dokumendi pealkirja ja põhipealkirja, liigutab fookust ainult siis, kui kasutaja on muudatuse algatanud, ja teatab lõpetamisest lühikese olekuteate kaudu. Säilitage brauseri ajalugu ja andke selge marsruut tagasi originaali juurde. Testige suumi, ümbervoolamist, klaviatuuri, ekraanilugejat, suurt kontrastsust, vähendatud liikumist ja tõlgitud silte.

Määratlege saadaoleva versiooni, taotluse ajalõpu, kehtetu konfiguratsiooni, blokeeritud skripti, toetamata brauseri ja hoolduse olekud. Iga osariik säilitab allika ja pakub ohutut järgmist tegevust. Ärge kuvage püsivat ketrust, tühja paneeli, töötlemata veakoodi ega juhtelementi, mis näivad toimivat, kuid jätab sisu muutmata. Kui JavaScript on keelatud, jäävad serveri renderdatud allikas ja kõik teadaolevad alternatiivse lehe lingid kättesaadavaks.

  • Lähteteekond jääb lõpule, kui vidin kunagi ei laadita.

  • Juhtelemendid kasutavad omakeelseid linke või nuppe, millel on heakskiidetud keelerežiimi nimetused.

  • Fookuse ja olekuteated on etteaimatavad ega ole pealetükkivad.

  • Igal ajalõpu ja kättesaamatus olekus on järgmine ohutu toiming.

  • Ükski analüüsi- ega diagnostikasündmus ei sisalda asjatult lehe teksti ega isiklikku teavet.

Testige hostikeskkonda ja jälgige tegelikku kohaletoimetamist

Testige tüüpiliste mallide, katkestuspunktide, brauserite, nõusolekuolekute, võrgukiiruste, sisu turbepoliitika, sildihaldurite ja abitehnoloogiatega. Kaasake korduv lähtestamine, kliendipoolne navigeerimine, dünaamiliselt sisestatud sisu, printimine, tõlkesildid, vahemälu aegumine, kättesaamatud tulemus, ajalõpp ja blokeeritud kolmanda osapoole päring. Veenduge, et vidin ei loo duplikaate ID-sid, vale päise järjekorda, fookuse lõksu, paigutuse nihutamist ega vastuolulisi globaalseid stiile.

Jälgige laadimise edukust, versiooni saadavust, reageerimisaega, renderdamise erandeid, aegunud allika versioone ja kasutaja algatatud režiimi valikut. Näidis hostimalli ja skriptiversiooni, mitte isikliku identiteedi järgi. Määratlege omanik, hoiatuslävi, tagasipööramise versioon ja hosti suhtlusprotsess. Väljalase aktsepteeritakse, kui allikas jääb kasutatav iga simuleeritud tõrke korral, kriitilised ülesanded töötavad klaviatuuri ja ekraanilugeja abil ning eelmise skriptiversiooni saab taastada ilma hostilehe muudatusteta.

Rollid, tõendid ja heakskiit

Hoidke genereerimine avaldamisest eraldi. Edukas vastus on mustand, mitte heakskiit. Salvestage allika identifikaator ja versioon, teisendusseaded, tulemuse identifikaator, ülevaatuse olek, kinnitaja ja avaldamise aeg. Kui allikas muutub, märkige heakskiidetud sisu vaikselt asendamise asemel ülevaatamiseks keeleversioon. See muudab tagasipööramise ja auditi võimalikuks platvormide lõikes.

Toimingud ja hooldus

Töö avaldamisega ei lõpe. Linkige keeleversioon või konfiguratsioon selle allikaga, jälgige kvaliteedi- ja teenindusmeetmeid ning määrake konkreetsed ülevaatuse käivitajad. Käivitajad hõlmavad allikamuudatusi, juriidilisi muudatusi, uusi vaatajaskonna vajadusi, korduvaid tugiküsimusi, tehnilisi muudatusi ja vahejuhtumeid. Nimega omanik hindab päästikut, avab vajaduse korral uue versiooni ja registreerib uuendatud kinnituse.

Avaldamise kontrollnimekiri

  • Integreerimine kasutab püsivaid allikaidentifikaatoreid.

  • Mandaadid salvestatakse serveri poole ja neid pööratakse.

  • Määratud on ajalõpp, uuesti proovimine ja kiiruspiirangu käitumine.

  • Korduvad taotlused on idempotentsed.

  • Loodud sisu läheb ülevaatuse olekusse.

  • Allika muudatused muudavad versiooni kehtetuks või avavad selle uuesti.

  • Keeles navigeerimine töötab klaviatuuri ja abitehnoloogia abil.

  • Järelevalve hõlmab tõrkeid, järjekordi, latentsust ja aegunud sisu.

Usaldusväärsed allikad

  1. Simple8 API dokumentatsioon
  2. Simple8 tarnemustrid
  3. Veebisisu juurdepääsetavuse juhised (WCAG) 2.2

Rakendage juhend praktikas

Testige esindusliku sisuga Simple8-i ja kasutage kontrollitud tootmise töövoo kavandamiseks kontrollnimekirja.

Testige oma teksti