CMS a API

Sprievodca widgetmi pre webové stránky.

Miniaplikáciu použite, keď záleží na rýchlom nasadení a stránka môže poskytnúť trvalé identifikátory zdroja a dostupnú jazykovú navigáciu.

Ujasnite si úlohu a rozhodnutie

Táto príručka premení sprievodcu miniaplikáciami webovej lokality na prehľadný prevádzkový pracovný postup. Spája rozhodnutia o doméne, vlastníctvo, dôkazy a akceptovanie, takže výsledok naďalej funguje vo výrobe.

Miniaplikáciu použite, keď záleží na rýchlom nasadení a stránka môže poskytnúť trvalé identifikátory zdroja a dostupnú jazykovú navigáciu.

Praktický postup

  1. 1

    Typy zdrojov inventára, identifikátory, polia, miestne nastavenia, vlastníci a stavy publikácie.

  2. 2

    Vyberte si vzor doručenia z objemu, latencie, redakčnej kontroly a tolerancie zlyhania.

  3. 3

    Mapujte zdrojový záznam do samostatného záznamu jazykovej verzie s trvalým prepojením.

  4. 4

    Pridajte autentifikáciu, idempotenciu, opakovanie, zrušenie platnosti vyrovnávacej pamäte, protokolovanie a riadenie prístupu.

  5. 5

    Testovacia publikácia, zmeny zdroja, nedostupné výsledky, vrátenie späť, ovládanie klávesnice a monitorovanie pred vydaním.

Príklad alebo nástroj

Vzor nasadenia zahŕňa načítanie, nedostupné verzie, správu zamerania, analýzy a správanie bez skriptu. V nástroji tiež zaznamenajte základnú líniu, vlastníka, rozhodnutie, dôkazy, otvorený problém a dátum schválenia. Použite skutočnú stránku alebo transakciu, aby tím videl závislosti, výnimky a údržbu, ktorá nasleduje po vydaní.

Rozhodovací bodZáznamAkceptačné kritérium
Základná líniaPozorovaný aktuálny stavZdroj a dátum zaznamenania
rozhodnutieVybraná možnosť a zdôvodnenieZvážte riziko a publikum
DôkazyTestujte, dokumentujte alebo merajteKontrolovateľné a špecifické pre verziu
SchválenieMeno, rola a dátumSplnené všetky povinné kritériá

Potvrďte, že miniaplikácia je správnym vzorom doručenia

Widget je vhodný, keď hostiteľská lokalita môže poskytnúť stabilné identifikátory zdroja, stránky zdieľajú predvídateľnú štruktúru obsahu, záleží na rýchlom nasadení a ak je prijateľné vylepšenie na strane klienta. Je menej vhodný, keď musia byť alternatívne verzie plne indexované, musia fungovať pod prísnymi obmedzeniami skriptov alebo patria do komplexnej overenej cesty. V týchto prípadoch poskytujú serverom vykreslené stránky alebo integrácia CMS silnejšiu kontrolu.

Vyplňte krátky záznam o rozhodnutí o architektúre zahŕňajúci vlastníctvo obsahu, údaje odoslané do služby, hosťovanie skriptov, dôsledky súhlasu, zásady zabezpečenia obsahu, rozpočet na výkon, podporu prehliadača, dostupnosť, správanie pri vyhľadávaní, analýzy, stav zlyhania a zodpovednosť za údržbu. Miniaplikácia musí vylepšiť stránku a nie sa stať jedinou cestou k základným informáciám. Pôvodná služba zostáva použiteľná, keď je skript zablokovaný, pomalý alebo nedostupný.

KritériumDobrý strih widgetuUprednostňujte doručovanie na strane servera
SpustiťKontrolovaná lokalita potrebuje rýchle pridanieVyžaduje sa hlboký pracovný postup CMS a ovládanie uvoľnenia
DiscoveryZdroj jasne odkazuje na rozšírenú verziuAlternatívna stránka potrebuje nezávislé indexovanie vyhľadávania
OdolnosťZdroj zostáva úplným záložným zdrojomAlternatívna verzia je nevyhnutná na dokončenie úlohy
BezpečnosťSchválený skript a tok údajov zodpovedajú pravidlám lokalityPrísne obmedzenia skriptu alebo overeného kontextu

Načítajte postupne a chráňte výkon stránky

Poskytujte malý verziovaný zavádzač zo schváleného pôvodu s integritou subresource tam, kde to model nasadenia podporuje. Načítajte ho s odkladom, inicializujte ho až vtedy, keď existuje príslušný kontajner, a vyhnite sa blokovaniu primárneho obsahu. Hostiteľ poskytuje stabilné ID stránky, revíziu zdroja, miestne nastavenie a povolené jazykové režimy prostredníctvom overenej konfigurácie. Do atribútov údajov nikdy neumiestňujte poverenia API, osobné údaje ani neobmedzený kód HTML.

Vyhraďte si priestor rozloženia pre ovládacie prvky alebo ich vložte bez posunutia hlavného nadpisu a obsahu úlohy. Nastavte výkonnostné rozpočty pre veľkosť skriptu, počet požiadaviek a oneskorenie interakcie. Prerušiť po definovanom časovom limite a odstrániť indikátory načítania. Ukladať do vyrovnávacej pamäte iba schválené verejné výsledky, pričom ich kľúčuje podľa revízie zdroja a režimu. Oneskorený alebo neúspešný widget neskryje, neduplikuje ani nenahradí zdrojovú stránku.

  1. 1

    Pridajte sémantický serverom vykreslený odkaz alebo zástupný symbol ovládacieho prvku blízko nadpisu stránky.

  2. 2

    Načítajte skript s verziou bez blokovania zdrojového obsahu.

  3. 3

    Overte konfiguráciu hostiteľa a požiadajte iba o schválenú verejnú verziu.

  4. 4

    Vykresľovanie ovládacích prvkov a obsahu s natívnou sémantikou a predvídateľným zameraním.

  5. 5

    Hlásenie prevádzkového stavu bez odosielania zbytočného obsahu stránky alebo používateľských údajov.

Navrhnite navigáciu a každý poruchový stav

Ak má jazyková verzia vlastnú adresu, použite obyčajný odkaz. Ak sa obsah zmení na svojom mieste, použite tlačidlo, ktoré pomenuje cieľový režim, podľa potreby aktualizuje názov dokumentu a hlavný nadpis, presunie zameranie iba vtedy, keď zmenu inicioval používateľ, a ohlási dokončenie prostredníctvom stručnej správy o stave. Zachovať históriu prehliadača a poskytnúť jasnú cestu späť k originálu. Otestujte priblíženie, preformátovanie, klávesnicu, čítačku obrazovky, vysoký kontrast, znížený pohyb a preložené štítky.

Definujte stavy pre nedostupnú verziu, časový limit požiadavky, neplatnú konfiguráciu, zablokovaný skript, nepodporovaný prehliadač a údržbu služby. Každý štát uchováva zdroj a ponúka bezpečnú ďalšiu akciu. Nezobrazujte trvalý číselník, prázdny panel, nespracovaný chybový kód ani ovládací prvok, ktorý vyzerá, že funguje, no obsah ponecháva nezmenený. Ak je JavaScript vypnutý, serverom vykreslený zdroj a akýkoľvek známy odkaz na alternatívnu stránku zostanú dostupné.

  • Zdrojová cesta zostane dokončená, keď sa miniaplikácia nikdy nenačíta.

  • Ovládacie prvky používajú natívne odkazy alebo tlačidlá so schválenými názvami jazykového režimu.

  • Zameranie a správy o stave sú predvídateľné a nie sú rušivé.

  • Každý časový limit a nedostupný stav má bezpečnú ďalšiu akciu.

  • Žiadna analytická ani diagnostická udalosť neobsahuje zbytočne text stránky ani osobné informácie.

Otestujte hostiteľské prostredie a sledujte skutočné doručenie

Otestujte reprezentatívne šablóny, body prerušenia, prehliadače, stavy súhlasu, rýchlosti siete, zásady zabezpečenia obsahu, správcov značiek a pomocné technológie. Zahŕňa opakovanú inicializáciu, navigáciu na strane klienta, dynamicky vkladaný obsah, tlač, prekladové štítky, vypršanie platnosti vyrovnávacej pamäte, nedostupný výsledok, časový limit a zablokovanú požiadavku tretej strany. Uistite sa, že miniaplikácia nevytvára duplicitné ID, neplatné poradie nadpisov, presahy zamerania, posun rozloženia alebo konfliktné globálne štýly.

Monitorujte úspešnosť načítania, dostupnosť verzie, čas odozvy, výnimky vykresľovania, revízie zastaralých zdrojov a výber režimu spusteného používateľom. Vzorka podľa šablóny hostiteľa a verzie skriptu, nie podľa osobnej identity. Definujte vlastníka, prah výstrahy, verziu vrátenia a proces komunikácie s hostiteľom. Vydanie je akceptované, keď zdroj zostane použiteľný pri každom simulovanom zlyhaní, kritické úlohy fungujú pomocou klávesnice a čítačky obrazovky a predchádzajúcu verziu skriptu je možné obnoviť bez zmien hostiteľskej stránky.

Úlohy, dôkazy a schválenie

Generovanie uchovávajte oddelene od publikácie. Úspešná odpoveď je návrh, nie schválenie. Uložte identifikátor a verziu zdroja, nastavenia transformácie, identifikátor výsledku, stav recenzie, schvaľovateľa a čas zverejnenia. Keď sa zdroj zmení, namiesto tichého nahradenia schváleného obsahu označte jazykovú verziu na kontrolu. To umožňuje rollback a audit naprieč platformami.

Prevádzka a údržba

Publikovaním práca nekončí. Prepojte jazykovú verziu alebo konfiguráciu s jej zdrojom, monitorujte opatrenia na kvalitu a služby a definujte konkrétne spúšťače kontroly. Spúšťače zahŕňajú zmeny zdroja, právne zmeny, nové potreby publika, opakujúce sa otázky podpory, technické zmeny a incidenty. Pomenovaný vlastník vyhodnotí spúšťač, v prípade potreby otvorí novú revíziu a zaznamená obnovené schválenie.

Kontrolný zoznam na zverejnenie

  • Integrácia využíva trvalé identifikátory zdroja.

  • Poverenia sú uložené na strane servera a rotujú sa.

  • Časový limit, opakovanie a správanie pri obmedzení rýchlosti sú definované.

  • Opakované žiadosti sú idempotentné.

  • Vygenerovaný obsah prejde do stavu kontroly.

  • Zmeny zdroja znehodnotia alebo znova otvoria verziu.

  • Jazyková navigácia funguje pomocou klávesnice a asistenčnej technológie.

  • Monitorovanie pokrýva zlyhania, fronty, latenciu a zastaraný obsah.

Odborné zdroje

  1. Simple8 Dokumentácia API
  2. Vzory dodávky Simple8
  3. Smernice o prístupnosti webového obsahu (WCAG) 2.2

Uveďte návod do praxe

Otestujte Simple8 s reprezentatívnym obsahom a použite kontrolný zoznam na plánovanie riadeného výrobného pracovného postupu.

Otestujte si svoj vlastný text