CMS un API

Vietnes logrīku ceļvedis.

Izmantojiet logrīku, ja ir svarīga ātra izvietošana, un vietne var nodrošināt noturīgus avota identifikatorus un pieejamu valodu navigāciju.

Noskaidrojiet uzdevumu un lēmumu

Šī rokasgrāmata pārvērš vietnes logrīku rokasgrāmatu par pārskatāmu darbības darbplūsmu. Tas savieno domēna lēmumus, īpašumtiesības, pierādījumus un pieņemšanu, lai rezultāts turpinātu darboties ražošanā.

Izmantojiet logrīku, ja ir svarīga ātra izvietošana, un vietne var nodrošināt noturīgus avota identifikatorus un pieejamu valodu navigāciju.

Praktiskā darba gaita

  1. 1

    Krājumu avotu veidi, identifikatori, lauki, lokalizācijas, īpašnieki un publikācijas stāvokļi.

  2. 2

    Izvēlieties piegādes modeli no skaļuma, latentuma, redakcionālās kontroles un kļūdu pielaides.

  3. 3

    Kartējiet avota ierakstu ar atsevišķu valodas versijas ierakstu ar izturīgu saiti.

  4. 4

    Pievienojiet autentifikāciju, idempotenci, atkārtotu mēģinājumu, kešatmiņas nederīgumu, reģistrēšanu un piekļuves vadīklas.

  5. 5

    Testa publikācija, avota izmaiņas, nepieejami rezultāti, atcelšana, tastatūras darbība un uzraudzība pirms izlaišanas.

Piemērs vai rīks

Izvietošanas modelis aptver ielādi, nepieejamās versijas, fokusa pārvaldību, analīzi un bezskripta darbību. Rīkā ierakstiet arī sākotnējo stāvokli, īpašnieku, lēmumu, pierādījumus, atklāto jautājumu un apstiprināšanas datumu. Izmantojiet īstu lapu vai darījumu, lai komanda redzētu atkarības, izņēmumus un uzturēšanas darbus pēc izlaišanas.

Lēmuma punktsIerakstsPieņemšanas kritērijs
PamatlīnijaNovērots pašreizējais stāvoklisAvots un ierakstīšanas datums
LēmumsIzvēlētais variants un pamatojumsApsvērts risks un auditorija
PierādījumiPārbaudi, dokumentē vai mēraPārskatāms un konkrētai versijai
ApstiprināšanaVārds, loma un datumsVisi obligātie kritēriji ir izpildīti

Apstipriniet, ka logrīks ir pareizais piegādes modelis

Logrīks ir piemērots, ja resursdatora vietne var nodrošināt stabilus avota identifikatorus, lapām ir kopīga paredzama satura struktūra, ir svarīga ātra izvietošana un ir pieņemami klienta puses uzlabojumi. Tas ir mazāk piemērots gadījumos, kad alternatīvajām versijām ir jābūt pilnībā indeksētām, tām ir jādarbojas saskaņā ar stingriem skripta ierobežojumiem vai tās pieder sarežģītam autentificētam ceļojumam. Šādos gadījumos servera renderētās lapas vai CMS integrācija nodrošina spēcīgāku kontroli.

Aizpildiet īsu arhitektūras lēmumu ierakstu, kas aptver satura īpašumtiesības, pakalpojumam nosūtītos datus, skriptu mitināšanu, piekrišanas ietekmi, satura drošības politiku, veiktspējas budžetu, pārlūkprogrammas atbalstu, pieejamību, meklēšanas darbību, analīzi, kļūmes stāvokli un uzturēšanas atbildību. Logrīkam ir jāuzlabo lapa, nevis jākļūst par vienīgo ceļu uz būtisku informāciju. Sākotnējais pakalpojums paliek lietojams, ja skripts ir bloķēts, lēns vai nav pieejams.

KritērijsLabi piemērots logrīkamDodiet priekšroku piegādei servera pusē
PalaistKontrolētai vietnei ir nepieciešams ātrs papildinājumsNepieciešama dziļa CMS darbplūsma un atbrīvošanas kontrole
AtklājumsAvots skaidri norāda uz uzlaboto versijuAlternatīvai lapai ir nepieciešama neatkarīga meklēšanas indeksācija
IzturībaAvots paliek pilnīgs rezerves variantsLai pabeigtu uzdevumu, ir nepieciešama alternatīva versija
DrošībaApstiprināta skriptu un datu plūsmas atbilstības vietņu politikaStingri skripta vai autentificēta konteksta ierobežojumi

Ielādējiet pakāpeniski un aizsargājiet lapas veiktspēju

Apkalpojiet mazu versiju ielādētāju no apstiprinātas izcelsmes ar apakšresursa integritāti, ja izvietošanas modelis to atbalsta. Ielādējiet to ar atlikšanu, inicializējiet tikai pēc attiecīgā konteinera pastāvēšanas un izvairieties no primārā satura bloķēšanas. Saimniekdators nodrošina stabilu lapas ID, avota versiju, lokalizāciju un atļautos valodas režīmus, izmantojot apstiprinātu konfigurāciju. Nekad neievietojiet datu atribūtos API akreditācijas datus, personas datus vai neierobežotu HTML.

Rezervējiet izkārtojuma vietu vadīklām vai ievietojiet tās, nepārvietojot galveno virsrakstu un uzdevuma saturu. Iestatiet veiktspējas budžetus skripta lielumam, pieprasījumu skaitam un mijiedarbības aizkavei. Pārtraukt pēc noteikta taimauta un noņemt ielādes indikatorus. Kešatmiņā saglabājiet tikai apstiprinātos publiskos rezultātus, ievadot tos pēc avota pārskatīšanas un režīma. Novēlots vai neizdevies logrīks neslēpj, nedublē un neaizstāj avota lapu.

  1. 1

    Blakus lapas virsrakstam pievienojiet semantisku servera atveidotu saiti vai vadīklas vietturi.

  2. 2

    Ielādējiet versijas skriptu, nebloķējot avota saturu.

  3. 3

    Apstipriniet saimniekdatora konfigurāciju un pieprasiet tikai apstiprinātu publisko versiju.

  4. 4

    Renderēšanas vadīklas un saturs ar vietējo semantiku un paredzamu fokusu.

  5. 5

    Ziņojiet par darbības stāvokli, nenosūtot nevajadzīgu lapas saturu vai lietotāja datus.

Dizaina navigācija un katrs atteices stāvoklis

Izmantojiet parastu saiti, ja valodas versijai ir sava adrese. Ja saturs mainās vietā, izmantojiet pogu, kas nosauc mērķa režīmu, atjaunina dokumenta nosaukumu un galveno virsrakstu pēc vajadzības, pārvieto fokusu tikai tad, kad lietotājs ir iniciējis izmaiņas, un paziņo par pabeigšanu, izmantojot īsu statusa ziņojumu. Saglabājiet pārlūkprogrammas vēsturi un nodrošiniet skaidru ceļu atpakaļ uz oriģinālu. Pārbaudiet tālummaiņu, pārpludināšanu, tastatūru, ekrāna lasītāju, augstu kontrastu, samazinātu kustību un tulkotās etiķetes.

Definējiet nepieejamās versijas, pieprasījuma noildzes, nederīgas konfigurācijas, bloķēta skripta, neatbalstītas pārlūkprogrammas un pakalpojumu uzturēšanas stāvokļus. Katra valsts saglabā avotu un piedāvā drošu nākamo darbību. Nerādīt pastāvīgu griezēju, tukšu paneli, neapstrādātu kļūdas kodu vai vadīklu, kas, šķiet, darbojas, bet saturs netiek mainīts. Ja JavaScript ir atspējots, servera renderētais avots un visas zināmās alternatīvās lapas saites paliek pieejamas.

  • Avota ceļš paliek pabeigts, kad logrīks nekad netiek ielādēts.

  • Vadīklas izmanto vietējās saites vai pogas ar apstiprinātiem valodas režīma nosaukumiem.

  • Fokusa un statusa ziņojumi ir paredzami un nav uzbāzīgi.

  • Katram taimauta un nepieejamības stāvoklim ir droša nākamā darbība.

  • Nevienā analītikas vai diagnostikas notikumā nav nevajadzīgi ietverts lapas teksts vai personas informācija.

Pārbaudiet saimniekdatora vidi un uzraugiet reālo piegādi

Pārbaudiet reprezentatīvās veidnes, pārtraukuma punktus, pārlūkprogrammas, piekrišanas stāvokļus, tīkla ātrumu, satura drošības politikas, tagu pārvaldniekus un palīgtehnoloģijas. Iekļaujiet atkārtotu inicializēšanu, klienta puses navigāciju, dinamiski ievietotu saturu, drukāšanu, tulkošanas etiķetes, kešatmiņas derīguma termiņu, nepieejamu rezultātu, taimautu un bloķētu trešās puses pieprasījumu. Apstipriniet, ka logrīks nerada dublētus ID, nederīgu virsrakstu secību, fokusa slazdus, ​​izkārtojuma maiņu vai konfliktējošus globālos stilus.

Pārraugiet veiksmīgu ielādi, versiju pieejamību, reakcijas laiku, renderēšanas izņēmumus, novecojušas avota versijas un lietotāja iniciētu režīma izvēli. Izlase pēc saimniekdatora veidnes un skripta versijas, nevis pēc personas identitātes. Definējiet īpašnieku, brīdinājuma slieksni, atcelšanas versiju un resursdatora saziņas procesu. Laidiens tiek pieņemts, ja avots joprojām ir izmantojams katras simulētās kļūmes gadījumā, kritiskos uzdevumus veic tastatūra un ekrāna lasītājs, un iepriekšējo skripta versiju var atjaunot bez saimniekdatora lapas izmaiņām.

Lomas, pierādījumi un apstiprinājums

Saglabājiet ģenerēšanu atsevišķi no publikācijas. Veiksmīga atbilde ir melnraksts, nevis apstiprinājums. Saglabājiet avota identifikatoru un versiju, transformācijas iestatījumus, rezultāta identifikatoru, pārskatīšanas stāvokli, apstiprinātāju un publicēšanas laiku. Kad avots mainās, atzīmējiet valodas versiju pārskatīšanai, nevis klusi nomainiet apstiprināto saturu. Tas padara iespējamu atcelšanu un auditu visās platformās.

Darbības un apkope

Darbs nebeidzas ar publicēšanu. Saistiet valodas versiju vai konfigurāciju ar tās avotu, uzraugiet kvalitātes un pakalpojumu pasākumus un definējiet konkrētus pārskatīšanas aktivizētājus. Aktivizētāji ietver avota izmaiņas, juridiskās izmaiņas, jaunas auditorijas vajadzības, periodiskus atbalsta jautājumus, tehniskas izmaiņas un incidentus. Nosaukts īpašnieks novērtē aktivizētāju, vajadzības gadījumā atver jaunu versiju un reģistrē atjaunoto apstiprinājumu.

Publicēšanas kontrolsaraksts

  • Integrācija izmanto noturīgus avota identifikatorus.

  • Akreditācijas dati tiek saglabāti servera pusē un pagriezti.

  • Noildze, atkārtots mēģinājums un ātruma ierobežojuma darbība ir definēta.

  • Atkārtoti pieprasījumi ir idempotenti.

  • Ģenerētais saturs nonāk pārskatīšanas stāvoklī.

  • Avota izmaiņas padara versiju nederīgu vai atkārtoti atver versiju.

  • Valodu navigācija darbojas, izmantojot tastatūru un palīgtehnoloģijas.

  • Uzraudzība attiecas uz kļūmēm, rindām, latentumu un novecojušu saturu.

Autoritatīvi avoti

  1. Simple8 API dokumentācija
  2. Simple8 piegādes modeļi
  3. Tīmekļa satura pieejamības vadlīnijas (WCAG) 2.2

Izmantojiet rokasgrāmatu praksē

Pārbaudiet Simple8 ar reprezentatīvu saturu un izmantojiet kontrolsarakstu, lai plānotu kontrolētu ražošanas darbplūsmu.

Pārbaudi savu tekstu