CMS och API

WordPress implementeringsguide.

Välj widget- eller API-leverans medvetet, behåll originalsidan kanonisk och publicera språkversioner genom revisioner.

Förtydliga uppgiften och beslutet

Denna guide förvandlar implementeringsguiden för wordpress till ett operativt arbetsflöde som kan granskas. Det kopplar samman domänbeslut, ägande, bevis och acceptans så att resultatet fortsätter att fungera i produktionen.

Välj widget- eller API-leverans medvetet, behåll originalsidan kanonisk och publicera språkversioner genom revisioner.

Praktiskt arbetsflöde

  1. 1

    Källtyper, identifierare, fält, lokaler, ägare och publiceringstillstånd.

  2. 2

    Välj leveransmönster från volym, latens, redaktionell kontroll och feltolerans.

  3. 3

    Mappa källposten till en separat språkversionspost med hållbar länkning.

  4. 4

    Lägg till autentisering, idempotens, försök igen, cache-ogiltigförklaring, loggning och åtkomstkontroller.

  5. 5

    Testpublicering, källändringar, otillgängliga resultat, återställning, tangentbordsdrift och övervakning före release.

Exempel eller verktyg

Ett Gutenberg-arbetsflöde kartlägger källsidor, granskningslägen, cache-tangenter och språknavigering. I verktyget registrerar du även baslinje, ägare, beslut, bevis, öppen fråga och godkännandedatum. Använd en riktig sida eller transaktion så att teamet ser beroenden, undantag och underhållsarbetet som följer efter release.

BeslutspunktSpela inAcceptanskriterium
BaslinjeObserverat aktuellt tillståndKälla och datum registreras
BeslutValt alternativ och motiveringRisk och publik beaktas
BevisTesta, dokumentera eller mätaGranskbar och versionsspecifik
GodkännandeNamn, roll och datumAlla obligatoriska kriterier uppfyllda

Välj widget-, plugin- eller API-leverans på serversidan

Använd en widget när distributionshastigheten spelar roll, källsidorna redan har hållbara identifierare och ett beroende på klientsidan är acceptabelt. Använd en WordPress-plugin när redaktörer behöver generera och granskas i administrationsgränssnittet. Använd API-leverans på serversidan när språkversioner måste indexeras, cachelagras, inkluderas i flöden och renderas även när JavaScript inte är tillgängligt. Stora utgivare kombinerar ofta ett plugin för arbetsflöde med server-side rendering för leverans.

Dokumentera valet mot redaktionell kontroll, prestanda, tillgänglighet, sökning, felbeteende, dataflöde och underhållsägande. Originalsidan förblir den auktoritativa källan. En språkversion får ett eget inlägg eller en strukturerad post, stabil URL, granskningsstatus och länk till källrevision. Undvik att endast lagra alternativt innehåll i ett anpassat fält eller webbläsarcache utan version eftersom granskare inte på ett tillförlitligt sätt kan godkänna, återställa eller granska det.

MönsterBäst passformPrimär kontroll
WidgetSnabbt tillägg till en kontrollerad webbplatsTillgängligt reserv- och feltillstånd
Plugin arbetsflödeRedaktörer fungerar helt i WordPressRoller, nonces, förmågor och revisioner
Server-side APIIndexerade, cachebara, spänstiga sidorKö, cache-ogiltigförklaring och driftsättning

Modellera källrelationer och redaktionella tillstånd

Skapa en inläggstyp i språkversion eller använd en flerspråkig struktur som stöder explicita källrelationer. Butikskällans inläggs-ID, källversions-ID, målspråk, språkläge, resultat-ID, ordlistaversion, granskningsstatus, godkännare, publicerad version och granskningsutlösare. Behåll den transformerade blockstrukturen där det är möjligt så att rubriker, listor, länkar, tabeller och meddelanden förblir semantiska snarare än att de plattas till ett HTML-fält.

Definiera status för begärd, generering, utkast, ämnesgranskning, språkgranskning, godkänd, publicerad, inaktuell och misslyckad. Kartlägg varje övergång till en WordPress-funktion, inte bara en synlig knapp. En generator kan skapa ett utkast men kan inte godkänna det. När källan ändras, jämför dess revision med den godkända källversionen och flytta språkversionen till inaktuell eller recension krävs. Publicera inte ett återskapat resultat i tysthet.

  1. 1

    Registrera språkversionsposten och nödvändig metadata med sanering och REST-behörigheter.

  2. 2

    Kartlägg stödda Gutenberg-block och definiera beteende för block som inte stöds.

  3. 3

    Konfigurera roller och tillåtna statusövergångar.

  4. 4

    Generera till en separat revision och presentera en källjämförelse.

  5. 5

    Publicera endast efter nödvändiga godkännanden för innehållsrisknivån.

Cache säkert och ge hållbar språknavigering

Bygg cache-nycklar från webbplats, källpost-ID, källrevision, språkläge, språkläge och renderarversion. Ogiltigförklara den relaterade språksidan när dess godkända version ändras, dess källa ändras, ett delat block ändras eller en relevant terminologiregel publiceras på nytt. Om bearbetningen körs asynkront, visa den senast godkända versionen medan det nya utkastet granskas. Ersätt aldrig godkänt innehåll med ett tomt tillstånd eftersom generering inte är tillgänglig.

Lägg till språklänkar som vanliga server-renderade ankare med tydliga namn som "klarspråk" och "lättläst svenska". Inkludera ömsesidiga länkar till källsidan och korrigera metadata på alternativa språk. Behåll tangentbordets fokus efter en växling på sidan, och meddela en ruttändring endast genom den normala sidtiteln och rubriken. En saknad version bör förklara att den är otillgänglig och länka tillbaka till källan, inte dölja kontrollen eller loop tillbaka tyst.

  • Cache-nycklar inkluderar käll- och renderarversioner.

  • Den senast godkända sidan överlever API och köavbrott.

  • Språklänkar fungerar utan JavaScript och använder godkänd terminologi.

  • Kanonisk och alternativ metadata återspeglar det faktiska förhållandet.

  • Ändringar av delade block och ordlista utlöser berörda granskningsuppgifter.

Testa hela publicerings- och återställningsvägen

Använd en mellanliggande kopia med representativa Gutenberg-block, anpassade fält, inbäddade formulär, återanvändbara block och begränsade inlägg. Testgenerering, rolltillämpning, granskningskommentarer, schemalagd publicering, förhandsgranskning, cache-ogiltigförklaring, källuppdatering, inaktuell markering, radering, återställning och återställning. Bekräfta att REST-slutpunkter avvisar obehöriga läsningar och skrivningar och att bakgrundsjobb inte kan utlösas på flera ställen utan giltiga meddelanden eller serveruppgifter.

Före produktion, definiera köövervakning, ägande av fel, rotation av autentiseringsuppgifter, testning av pluginuppdateringar, säkerhetskopiering av databas och en säker inaktiveringsprocedur. Acceptans kräver korrekt rendering vid vanliga brytpunkter, navigering med tangentbord och skärmläsare, ingen layoutförskjutning från sent innehåll, giltiga strukturerade rubriker, spårbart godkännande och återställning av den senast godkända versionen. Spela in de stödda konfigurationerna för WordPress, PHP, editor, flerspråkig plugin och cachning.

Roller, bevis och godkännande

Håll generation åtskild från publicering. Ett framgångsrikt svar är ett utkast, inte ett godkännande. Lagra källidentifierare och version, transformationsinställningar, resultatidentifierare, granskningsstatus, godkännare och publiceringstid. När källan ändras, markera språkversionen för granskning istället för att tyst ersätta godkänt innehåll. Detta gör återställning och revision möjlig över plattformar.

Drift och underhåll

Arbetet slutar inte vid publicering. Länka språkversionen eller konfigurationen till dess källa, övervaka kvalitets- och serviceåtgärder och definiera konkreta granskningsutlösare. Triggers inkluderar källändringar, juridiska ändringar, nya publikbehov, återkommande supportfrågor, tekniska förändringar och incidenter. En namngiven ägare utvärderar utlösaren, öppnar en ny revision vid behov och registrerar förnyat godkännande.

Checklista före publicering

  • Integrationen använder hållbara källidentifierare.

  • Inloggningsuppgifter lagras på serversidan och roteras.

  • Timeout, försök igen och hastighetsgräns-beteende definieras.

  • Upprepade förfrågningar är idempotenta.

  • Genererat innehåll går in i ett granskningsläge.

  • Källändringar ogiltigförklarar eller öppnar versionen igen.

  • Språknavigering fungerar med tangentbord och hjälpmedel.

  • Övervakning täcker fel, köer, latens och inaktuellt innehåll.

Auktoritativa källor

  1. Simple8 API dokumentation
  2. Simple8 leveransmönster
  3. Riktlinjer för tillgänglighet till webbinnehåll (WCAG) 2.2

Omsätt guiden i praktiken

Testa Simple8 med representativt innehåll och använd checklistan för att planera ett kontrollerat produktionsarbetsflöde.

Testa din egen text