CMS a API

Průvodce widgety pro webové stránky.

Používejte widget, když záleží na rychlém nasazení a web může poskytovat trvalé identifikátory zdroje a dostupnou jazykovou navigaci.

Ujasněte si úkol a rozhodnutí

Tato příručka změní průvodce widgety webových stránek na přehledný provozní pracovní postup. Propojuje rozhodování o doméně, vlastnictví, důkazy a přijímání, takže výsledek nadále funguje v produkci.

Používejte widget, když záleží na rychlém nasazení a web může poskytovat trvalé identifikátory zdroje a dostupnou jazykovou navigaci.

Praktický postup

  1. 1

    Typy zdrojů inventáře, identifikátory, pole, národní prostředí, vlastníci a stavy publikace.

  2. 2

    Vyberte vzor doručení z objemu, latence, redakční kontroly a odolnosti proti selhání.

  3. 3

    Mapujte zdrojový záznam na samostatný záznam jazykové verze s trvalým propojením.

  4. 4

    Přidejte ověřování, idempotency, opakování, zneplatnění mezipaměti, protokolování a řízení přístupu.

  5. 5

    Testovací publikace, změny zdroje, nedostupné výsledky, vrácení zpět, ovládání klávesnice a monitorování před vydáním.

Příklad nebo nástroj

Vzor nasazení pokrývá načítání, nedostupné verze, správu fokusu, analýzy a chování bez skriptu. V nástroji také zaznamenejte výchozí stav, vlastníka, rozhodnutí, důkazy, otevřený problém a datum schválení. Použijte skutečnou stránku nebo transakci, aby tým viděl závislosti, výjimky a údržbu, která následuje po vydání.

Rozhodovací bodZáznamKritérium přijetí
Základní liniePozorovaný aktuální stavZdroj a datum zaznamenány
RozhodnutíVybraná možnost a zdůvodněníZváženo riziko a publikum
DůkazTestujte, dokumentujte nebo měřteKontrolovatelné a specifické pro verzi
SchváleníJméno, role a datumSplněna všechna povinná kritéria

Potvrďte, že widget je správný vzor doručení

Widget je vhodný, když hostitelský web může poskytovat stabilní zdrojové identifikátory, stránky sdílejí předvídatelnou strukturu obsahu, záleží na rychlém nasazení a vylepšení na straně klienta je přijatelné. Je méně vhodný, když musí být alternativní verze plně indexovány, musí fungovat pod přísnými omezeními skriptů nebo musí patřit ke složité autentizované cestě. V těchto případech poskytují stránky vykreslené serverem nebo integrace CMS silnější kontrolu.

Vyplňte krátký záznam o rozhodnutí o architektuře zahrnující vlastnictví obsahu, data odeslaná službě, hostování skriptů, důsledky souhlasu, zásady zabezpečení obsahu, rozpočet na výkon, podporu prohlížeče, dostupnost, chování při vyhledávání, analýzy, stav selhání a odpovědnost za údržbu. Widget musí vylepšit stránku a ne se stát jedinou cestou k základním informacím. Původní služba zůstává použitelná, když je skript zablokovaný, pomalý nebo nedostupný.

KritériumDobře padnoucí widgetPreferujte doručování na straně serveru
ZahájitKontrolovaný web potřebuje rychlé přidáníJe vyžadován hluboký pracovní postup CMS a kontrola uvolnění
ObjevZdroj jasně odkazuje na vylepšenou verziAlternativní stránka potřebuje nezávislé indexování vyhledávání
OdolnostZdroj zůstává úplný záložní zdrojPro dokončení úkolu je nezbytná alternativní verze
ZabezpečeníSchválený skript a tok dat odpovídají zásadám webuPřísná omezení skriptu nebo ověřeného kontextu

Načítat postupně a chránit výkon stránky

Poskytujte malý verzovaný zavaděč ze schváleného původu s integritou subresource tam, kde to model nasazení podporuje. Načtěte jej s odložením, inicializujte jej až poté, co příslušný kontejner existuje, a vyhněte se blokování primárního obsahu. Hostitel poskytuje stabilní ID stránky, revizi zdroje, národní prostředí a povolené jazykové režimy prostřednictvím ověřené konfigurace. Do atributů dat nikdy neumisťujte pověření API, osobní údaje ani neomezený kód HTML.

Vyhraďte prostor pro rozvržení pro ovládací prvky nebo je vložte bez posunutí hlavního nadpisu a obsahu úkolu. Nastavte výkonové rozpočty pro velikost skriptu, počet požadavků a zpoždění interakce. Přerušit po uplynutí definovaného časového limitu a odstranit indikátory načítání. Ukládání do mezipaměti pouze schválené veřejné výsledky a jejich klíčování podle revize zdroje a režimu. Pozdní nebo neúspěšný widget neskryje, neduplikuje ani nenahradí zdrojovou stránku.

  1. 1

    Přidejte sémantický serverem vykreslený odkaz nebo zástupný symbol ovládacího prvku poblíž záhlaví stránky.

  2. 2

    Načtěte skript s verzí bez blokování zdrojového obsahu.

  3. 3

    Ověřte konfiguraci hostitele a vyžádejte si pouze schválenou veřejnou verzi.

  4. 4

    Vykreslování ovládacích prvků a obsahu s nativní sémantikou a předvídatelným zaměřením.

  5. 5

    Hlásit provozní stav bez odesílání zbytečného obsahu stránky nebo uživatelských dat.

Navrhněte navigaci a každý poruchový stav

Pokud má jazyková verze vlastní adresu, použijte běžný odkaz. Pokud se obsah změní na místě, použijte tlačítko, které pojmenuje cílový režim, podle potřeby aktualizuje název dokumentu a hlavní nadpis, přesune fokus pouze tehdy, když uživatel změnu inicioval, a oznámí dokončení prostřednictvím stručné stavové zprávy. Zachovejte historii prohlížeče a poskytněte jasnou cestu zpět k originálu. Otestujte zoom, přeformátování, klávesnici, čtečku obrazovky, vysoký kontrast, snížený pohyb a přeložené štítky.

Definujte stavy pro nedostupnou verzi, časový limit požadavku, neplatnou konfiguraci, zablokovaný skript, nepodporovaný prohlížeč a údržbu služeb. Každý stát uchovává zdroj a nabízí bezpečnou další akci. Nezobrazujte trvalý číselník, prázdný panel, nezpracovaný chybový kód nebo ovládací prvek, který vypadá, že funguje, ale ponechává obsah beze změny. Pokud je JavaScript vypnutý, serverem vykreslený zdroj a jakýkoli známý odkaz na alternativní stránku zůstanou dostupné.

  • Zdrojová cesta zůstane dokončena, když se widget nikdy nenačte.

  • Ovládací prvky používají nativní odkazy nebo tlačítka se schválenými názvy jazykového režimu.

  • Zaměření a zprávy o stavu jsou předvídatelné a nejsou rušivé.

  • Každý časový limit a nedostupný stav má bezpečnou další akci.

  • Žádná analytická nebo diagnostická událost neobsahuje zbytečně text stránky nebo osobní informace.

Otestujte hostitelské prostředí a sledujte skutečné doručení

Vyzkoušejte reprezentativní šablony, body přerušení, prohlížeče, stavy souhlasu, rychlosti sítě, zásady zabezpečení obsahu, správce značek a pomocné technologie. Zahrnuje opakovanou inicializaci, navigaci na straně klienta, dynamicky vkládaný obsah, tisk, překladové štítky, vypršení platnosti mezipaměti, nedostupný výsledek, časový limit a zablokovaný požadavek třetí strany. Ujistěte se, že widget nevytváří duplicitní ID, neplatné pořadí nadpisů, pasti fokusu, posun rozvržení nebo konfliktní globální styly.

Monitorujte úspěšnost načítání, dostupnost verze, dobu odezvy, výjimky vykreslování, zastaralé revize zdroje a uživatelsky iniciovaný výběr režimu. Vzorek podle šablony hostitele a verze skriptu, nikoli podle osobní identity. Definujte vlastníka, prahovou hodnotu výstrahy, verzi vrácení zpět a proces komunikace s hostitelem. Vydání je přijato, když zdroj zůstane použitelný při každém simulovaném selhání, kritické úlohy fungují pomocí klávesnice a čtečky obrazovky a předchozí verze skriptu může být obnovena bez změn hostitelské stránky.

Role, důkazy a schválení

Generování uchovávejte odděleně od publikace. Úspěšná odpověď je návrh, nikoli schválení. Uložte identifikátor zdroje a verzi, nastavení transformace, identifikátor výsledku, stav recenze, schvalovatele a čas publikace. Když se zdroj změní, místo tichého nahrazování schváleného obsahu označte jazykovou verzi ke kontrole. To umožňuje rollback a audit napříč platformami.

Provoz a údržba

Publikací práce nekončí. Propojte jazykovou verzi nebo konfiguraci s jejím zdrojem, sledujte měření kvality a služeb a definujte konkrétní spouštěče kontroly. Spouštěče zahrnují změny zdroje, právní změny, nové potřeby publika, opakující se otázky podpory, technické změny a incidenty. Jmenovaný vlastník vyhodnotí spouštěč, v případě potřeby otevře novou revizi a zaznamená obnovené schválení.

Kontrolní seznam pro zveřejnění

  • Integrace využívá trvalé identifikátory zdroje.

  • Pověření se ukládají na straně serveru a střídají se.

  • Je definován časový limit, opakování a chování při omezení rychlosti.

  • Opakované žádosti jsou idempotentní.

  • Vygenerovaný obsah přejde do stavu recenze.

  • Změny zdroje zruší platnost nebo znovu otevřou verzi.

  • Jazyková navigace funguje pomocí klávesnice a asistenční technologie.

  • Monitorování pokrývá selhání, fronty, latenci a zastaralý obsah.

Odborné zdroje

  1. Simple8 Dokumentace API
  2. Vzory dodávek Simple8
  3. Pokyny pro přístupnost webového obsahu (WCAG) 2.2

Uveďte návod do praxe

Otestujte Simple8 s reprezentativním obsahem a použijte kontrolní seznam k plánování řízeného výrobního pracovního postupu.

Otestujte si svůj vlastní text