CMS și API

Ghid de implementare WordPress.

Alegeți livrarea widget sau API în mod deliberat, păstrați pagina originală canonică și publicați versiuni lingvistice prin revizuiri.

Clarificați sarcina și decizia

Acest ghid transformă ghidul de implementare wordpress într-un flux de lucru de operare care poate fi revizuit. Conectează deciziile de domeniu, proprietatea, dovezile și acceptarea, astfel încât rezultatul să continue să funcționeze în producție.

Alegeți livrarea widget sau API în mod deliberat, păstrați pagina originală canonică și publicați versiuni lingvistice prin revizuiri.

Proces practic

  1. 1

    Tipuri de surse de inventar, identificatori, câmpuri, locații, proprietari și stări de publicare.

  2. 2

    Alegeți modelul de livrare dintre volum, latență, control editorial și toleranță la eșec.

  3. 3

    Mapați înregistrarea sursă într-o înregistrare separată a versiunii de limbă cu o legătură durabilă.

  4. 4

    Adăugați autentificare, idempotence, reîncercare, invalidare cache, logare și controale de acces.

  5. 5

    Testează publicarea, modificările sursei, rezultatele indisponibile, derularea înapoi, operarea tastaturii și monitorizarea înainte de lansare.

Exemplu sau instrument

Un flux de lucru Gutenberg mapează paginile sursă, stările de revizuire, cheile cache și navigarea în limbă. În instrument, înregistrați, de asemenea, valoarea de bază, proprietarul, decizia, dovezile, problema deschisă și data aprobării. Utilizați o pagină reală sau o tranzacție, astfel încât echipa să vadă dependențele, excepțiile și lucrările de întreținere care urmează după lansare.

Punct de decizieÎnregistraCriteriul de acceptare
Linia de bazăStarea curentă observatăSursa și data înregistrate
DecizieOpțiunea selectată și justificareaRisc și audiență luate în considerare
DoveziTestați, documentați sau măsurațiRevizuabil și specific versiunii
AprobareNume, rol și dataToate criteriile obligatorii îndeplinite

Alegeți livrarea prin widget, plugin sau server API

Utilizați un widget atunci când viteza de implementare contează, paginile sursă au deja identificatori durabili și este acceptabilă o dependență de partea clientului. Utilizați un plugin WordPress atunci când editorii au nevoie de generare și revizuire în interiorul interfeței de administrare. Utilizați livrarea API pe partea serverului atunci când versiunile lingvistice trebuie să fie indexate, stocate în cache, incluse în fluxuri și redate chiar și atunci când JavaScript nu este disponibil. Editorii mari combină adesea un plugin pentru fluxul de lucru cu randarea pe server pentru livrare.

Documentați alegerea împotriva controlului editorial, performanță, accesibilitate, căutare, comportament de eșec, fluxul de date și proprietatea de întreținere. Pagina originală rămâne sursa autorizată. O versiune lingvistică primește propria postare sau înregistrare structurată, adresă URL stabilă, stare de revizuire și link sursă-revizuire. Evitați stocarea conținutului alternativ numai într-un câmp personalizat neversionat sau în memoria cache a browserului, deoarece examinatorii nu îl pot aproba, restaura sau audita în mod fiabil.

ModelCel mai potrivitControl primar
WidgetAdăugarea rapidă la un site controlatStare de rezervă și de eroare accesibilă
Flux de lucru pentru pluginEditorii lucrează în întregime în WordPressRoluri, non-uri, capabilități și revizuiri
API pe partea serveruluiPagini indexate, stocabile în cache, rezistenteOperațiuni de coadă, de invalidare a memoriei cache și de implementare

Relații de sursă model și stări editoriale

Creați un tip de postare cu versiune de limbă sau utilizați o structură multilingvă care acceptă relații explicite de sursă. Stocați ID-ul postării sursă, ID-ul revizuirii sursă, localitatea țintă, modul de limbă, ID-ul rezultatului, versiunea glosarului, starea revizuirii, aprobatorii, revizuirea publicată și declanșatorul de revizuire. Păstrați structura de bloc transformată acolo unde este posibil, astfel încât titlurile, listele, linkurile, tabelele și notificările să rămână semantice în loc să fie aplatizate într-un singur câmp HTML.

Definiți stările pentru solicitat, generare, schiță, revizuire subiect, revizuire limbă, aprobat, publicat, învechit și eșuat. Harta fiecare tranzitie catre o capacitate WordPress, nu doar un buton vizibil. Un generator poate crea o schiță, dar nu o poate aproba. Când sursa se modifică, comparați revizuirea acesteia cu revizuirea sursă aprobată și mutați versiunea lingvistică în versiunea învechită sau revizuirea necesară. Nu publicați în tăcere un rezultat regenerat.

  1. 1

    Înregistrați înregistrarea versiunii de limbă și metadatele necesare cu permisiuni de dezinfectare și REST.

  2. 2

    Hartați blocurile Gutenberg acceptate și definiți comportamentul pentru blocurile neacceptate.

  3. 3

    Configurați rolurile și tranzițiile permise de stare.

  4. 4

    Generați într-o revizuire separată și prezentați o comparație de sursă.

  5. 5

    Publicați numai după aprobările necesare pentru nivelul de risc de conținut.

Memorați în cache în siguranță și oferiți o navigare durabilă în limbă

Creați chei cache de pe site, ID-ul postării sursă, revizuirea sursei, locale, modul de limbă și versiunea de redare. Invalidați pagina de limbă asociată atunci când revizuirea aprobată se modifică, sursa se modifică, se modifică un bloc partajat sau o regulă terminologică relevantă este republicată. Dacă procesarea rulează asincron, difuzați ultima versiune aprobată în timp ce noua versiune este revizuită. Nu înlocuiți niciodată conținutul aprobat cu o stare goală, deoarece generarea nu este disponibilă.

Adăugați link-uri de limbă ca ancore obișnuite redate de server cu nume clare, cum ar fi „limbaj clar” și „ușor de citit și de înțeles și de înțeles”. Includeți linkuri reciproce către pagina sursă și corectați metadatele în limbi alternative. Păstrați focalizarea de la tastatură după o schimbare în pagină și anunțați o schimbare a rutei numai prin titlul și titlul normal al paginii. O versiune lipsă ar trebui să explice că nu este disponibilă și să se conecteze înapoi la sursă, nu să ascundă controlul sau să se întoarcă înapoi în tăcere.

  • Cheile cache includ versiunile sursă și de redare.

  • Ultima pagină aprobată supraviețuiește API și întreruperi în coadă.

  • Legăturile de limbă funcționează fără JavaScript și folosesc terminologie aprobată.

  • Metadatele canonice și alternative reflectă relația reală.

  • Blocurile partajate și modificările glosarului declanșează sarcini de revizuire afectate.

Testați calea completă de publicare și rollback

Utilizați o copie provizorie cu blocuri Gutenberg reprezentative, câmpuri personalizate, formulare încorporate, blocuri reutilizabile și postări restricționate. Generarea de testare, aplicarea rolului, comentarii de revizuire, publicare programată, previzualizare, invalidare cache, actualizare sursă, marcare obținută, ștergere, restaurare și rollback. Confirmați că punctele finale REST resping citirile și scrierile neautorizate și că lucrările de fundal nu pot fi declanșate pe mai multe site-uri fără acreditări nonce sau server valide.

Înainte de producție, definiți monitorizarea cozii, proprietatea erorilor, rotația acreditărilor, testarea actualizării pluginurilor, backupul bazei de date și o procedură de dezactivare sigură. Acceptarea necesită redarea corectă la punctele de întrerupere obișnuite, navigare prin tastatură și cititor de ecran, nicio schimbare a aspectului de la conținutul târziu, titluri structurate valide, aprobare urmăribilă și restaurarea ultimei revizuiri aprobate. Înregistrați configurațiile acceptate pentru WordPress, PHP, editor, plugin multilingv și cache.

Roluri, dovezi și aprobare

Mențineți generația separată de publicare. Un răspuns de succes este o schiță, nu o aprobare. Stocați identificatorul și versiunea sursei, setările de transformare, identificatorul de rezultat, starea de revizuire, aprobarea și timpul de publicare. Când sursa se schimbă, marcați versiunea lingvistică pentru revizuire în loc să înlocuiți în tăcere conținutul aprobat. Acest lucru face posibilă rollback-ul și auditul pe toate platformele.

Operațiuni și întreținere

Lucrarea nu se termină la publicare. Conectați versiunea sau configurația lingvistică la sursa acesteia, monitorizați măsurile de calitate și servicii și definiți declanșatorii de revizuire concreti. Declanșatorii includ modificări de sursă, modificări legale, noi nevoi de public, întrebări de asistență recurente, modificări tehnice și incidente. Un proprietar numit evaluează declanșatorul, deschide o nouă revizuire atunci când este necesar și înregistrează aprobarea reînnoită.

Listă de verificare pentru publicare

  • Integrarea folosește identificatori durabili de sursă.

  • Acreditările sunt stocate pe partea serverului și rotite.

  • Timeout, reîncercarea și comportamentul limită de rată sunt definite.

  • Cererile repetate sunt idempotente.

  • Conținutul generat intră într-o stare de revizuire.

  • Modificările sursei invalidează sau redeschid versiunea.

  • Navigarea lingvistică funcționează prin tastatură și tehnologie de asistență.

  • Monitorizarea acoperă eșecurile, cozile, latența și conținutul învechit.

Surse de referință

  1. Simple8 API documentație
  2. Simple8 modele de livrare
  3. Orientări privind accesibilitatea conținutului web (WCAG) 2.2

Pune ghidul în practică

Testați Simple8 cu conținut reprezentativ și utilizați lista de verificare pentru a planifica un flux de lucru de producție controlat.

Testează-ți propriul text