CMS ja API

WordPress toteutusopas.

Valitse widget tai API-toimitus tietoisesti, pidä alkuperäinen sivu ensisijaisena ja julkaise kieliversiot versioiden kautta.

Selvitä tehtävä ja päätös

Tämä opas muuttaa wordpress-toteutusoppaan tarkistettavaksi käyttötyönkuluksi. Se yhdistää verkkotunnuksen päätökset, omistajuuden, todisteet ja hyväksynnän, jotta tulos toimii edelleen tuotannossa.

Valitse widget tai API-toimitus tietoisesti, pidä alkuperäinen sivu ensisijaisena ja julkaise kieliversiot versioiden kautta.

Käytännön työnkulku

  1. 1

    Varaston lähdetyypit, tunnisteet, kentät, alueet, omistajat ja julkaisutilat.

  2. 2

    Valitse toimitusmalli äänenvoimakkuuden, latenssin, toimituksellisen ohjauksen ja virhetoleranssin joukosta.

  3. 3

    Yhdistä lähdetietue erilliseksi kieliversiotietueeksi kestävällä linkityksellä.

  4. 4

    Lisää todennus, idempotenssi, uudelleenyritys, välimuistin mitätöinti, lokikirjaus ja pääsynhallinta.

  5. 5

    Testijulkaisu, lähdemuutokset, tulokset, joita ei ole saatavilla, palautus, näppäimistön käyttö ja valvonta ennen julkaisua.

Esimerkki tai työkalu

Gutenbergin työnkulku kartoittaa lähdesivut, tarkastelun tilat, välimuistin avaimet ja kielinavigoinnin. Tallenna työkaluun myös lähtökohta, omistaja, päätös, todisteet, avoin kysymys ja hyväksymispäivä. Käytä oikeaa sivua tai tapahtumaa, jotta tiimi näkee riippuvuudet, poikkeukset ja julkaisua seuraavat ylläpitotyöt.

PäätöskohtaTallentaaHyväksymiskriteeri
PerustasoHavaittu nykytilaLähde ja tallennuspäivämäärä
PäätösValittu vaihtoehto ja perustelutRiski ja yleisö huomioitu
TodisteetTestaa, dokumentoi tai mittaaTarkastettava ja versiokohtainen
HyväksyminenNimi, rooli ja päivämääräKaikki pakolliset kriteerit täyttyivät

Valitse widget, laajennus tai palvelinpuolen API-toimitus

Käytä widgetiä, kun käyttöönottonopeudella on väliä, lähdesivuilla on jo kestävät tunnisteet ja asiakaspuolen riippuvuus on hyväksyttävää. Käytä WordPress-laajennusta, kun editorit tarvitsevat luomista ja tarkistamista hallintaliittymän sisällä. Käytä palvelinpuolen API-toimitusta, kun kieliversiot on indeksoitava, tallennettava välimuistiin, sisällytettävä syötteisiin ja hahmonnettava, vaikka JavaScript ei olisi käytettävissä. Suuret julkaisijat yhdistävät usein työnkulun laajennuksen palvelinpuolen renderöintiin toimitusta varten.

Dokumentoi valinta toimituksellisen hallinnan, suorituskyvyn, käytettävyyden, haun, virhekäyttäytymisen, tietovirran ja ylläpidon omistajuuden suhteen. Alkuperäinen sivu pysyy luotettavana lähteenä. Kieliversio saa oman postauksen tai strukturoidun tietueen, vakaan URL-osoitteen, arvostelun tilan ja lähde-versiolinkin. Vältä tallentamasta vaihtoehtoista sisältöä vain versioittamattomaan mukautettuun kenttään tai selaimen välimuistiin, koska tarkistajat eivät voi luotettavasti hyväksyä, palauttaa tai tarkastaa sitä.

KuvioParas istuvuusEnsisijainen ohjaus
WidgetNopea lisäys valvottuun paikkaanHelppokäyttöinen vara- ja vikatila
Plugin työnkulkuToimittajat toimivat kokonaan WordPress:ssäRoolit, epäkohdat, ominaisuudet ja versiot
Palvelinpuolen APIIndeksoidut, välimuistiin tallennettavat, joustavat sivutJono-, välimuistin mitätöinti- ja käyttöönottotoiminnot

Mallin lähdesuhteet ja toimitukselliset tilat

Luo kieliversion viestityyppi tai käytä monikielistä rakennetta, joka tukee eksplisiittisiä lähdesuhteita. Tallenna lähdejulkaisun tunnus, lähteen versiotunnus, kohdealue, kielitila, tulostunnus, sanastoversio, tarkistuksen tila, hyväksyjät, julkaistu versio ja tarkistuskäynnistin. Säilytä muunnettu lohkorakenne mahdollisuuksien mukaan, jotta otsikot, luettelot, linkit, taulukot ja ilmoitukset pysyvät semanttisina sen sijaan, että ne litistettäisiin yhdeksi HTML-kenttään.

Määritä tilat pyydetylle, luotavalle, luonnokselle, aiheen tarkistukselle, kielitarkistukselle, hyväksytylle, julkaistulle, vanhentuneelle ja epäonnistuneelle. Yhdistä jokainen siirtymä WordPress-ominaisuuteen, ei vain näkyvään painikkeeseen. Generaattori voi luoda luonnoksen, mutta ei voi hyväksyä sitä. Kun lähde muuttuu, vertaa sen versiota hyväksyttyyn lähdeversioon ja siirrä kieliversio vanhentuneeksi tai vaaditaan tarkistus. Älä julkaise uudelleen luotua tulosta hiljaa.

  1. 1

    Rekisteröi kieliversiotietue ja vaaditut metatiedot puhdistus- ja REST-oikeuksilla.

  2. 2

    Kartoita tuetut Gutenberg-lohkot ja määritä ei-tuettujen lohkojen käyttäytyminen.

  3. 3

    Määritä roolit ja sallitut tilasiirtymät.

  4. 4

    Luo erillinen versio ja esitä lähdevertailu.

  5. 5

    Julkaise vasta, kun sisällön riskitason edellyttämät hyväksynnät on saatu.

Tallenna välimuistiin turvallisesti ja tarjoa kestävää kielinavigointia

Luo välimuistiavaimia sivustosta, lähdejulkaisun tunnuksesta, lähteen versiosta, alueesta, kielitilasta ja renderöintiversiosta. Kumoa aiheeseen liittyvä kielisivu, kun sen hyväksytty versio muuttuu, sen lähde muuttuu, jaettu lohko muuttuu tai asiaankuuluva terminologiasäännöt julkaistaan ​​uudelleen. Jos käsittely suoritetaan asynkronisesti, tarjoa viimeisin hyväksytty versio uuden luonnoksen tarkistamisen aikana. Älä koskaan korvaa hyväksyttyä sisältöä tyhjällä tilassa, koska luonti ei ole käytettävissä.

Lisää kielilinkkejä tavallisina palvelimen ankkureina selkeillä nimillä, kuten "selkeä kieli" ja "selkokieli". Sisällytä vastavuoroiset linkit lähdesivulle ja korjaa vaihtoehtoiset metatiedot. Säilytä näppäimistön kohdistus sivun sisäisen vaihdon jälkeen ja ilmoita reitin muutoksesta vain normaalin sivun otsikon ja otsikon kautta. Puuttuvan version tulee selittää, että se ei ole saatavilla, ja linkittää takaisin lähteeseen, ei piilottaa ohjausta tai palata äänettömästi takaisin.

  • Välimuistiavaimet sisältävät lähde- ja renderöijaversiot.

  • Viimeinen hyväksytty sivu selviää API- ja jonokatkoksista.

  • Kielilinkit toimivat ilman JavaScriptiä ja käyttävät hyväksyttyä terminologiaa.

  • Kanoniset ja vaihtoehtoiset metatiedot heijastavat todellista suhdetta.

  • Jaetun lohkon ja sanaston muutokset käynnistävät vaikutusten kohteena olevat tarkistustehtävät.

Testaa koko julkaisu- ja palautuspolku

Käytä esityskopiota edustavien Gutenberg-lohkojen, mukautettujen kenttien, upotettujen lomakkeiden, uudelleenkäytettävien lohkojen ja rajoitettujen viestien kanssa. Testin luominen, roolien täytäntöönpano, tarkistuskommentit, ajoitettu julkaisu, esikatselu, välimuistin mitätöinti, lähdepäivitys, vanhentunut merkintä, poistaminen, palautus ja palautus. Varmista, että REST-päätepisteet hylkäävät luvattoman luku- ja kirjoitustyöt ja että taustatöitä ei voida käynnistää eri paikoissa ilman kelvollisia nonce- tai palvelimen valtuustietoja.

Ennen tuotantoa määritä jonojen valvonta, virheiden omistajuus, tunnistetietojen kierto, laajennuksen päivitystestaus, tietokannan varmuuskopiointi ja turvallinen käytöstäpoistomenettely. Hyväksyminen edellyttää oikeaa renderöintiä yleisissä keskeytyspisteissä, näppäimistön ja näytönlukuohjelman navigointia, asettelun siirtymistä myöhäisestä sisällöstä, kelvollisia strukturoituja otsikoita, jäljitettävää hyväksyntää ja viimeisimmän hyväksytyn version palauttamista. Tallenna tuetut WordPress-, PHP-, editori-, monikieliset lisäosat ja välimuistiasetukset.

Roolit, todisteet ja hyväksyntä

Pidä sukupolvi erillään julkaisusta. Onnistunut vastaus on luonnos, ei hyväksyntä. Tallenna lähteen tunniste ja versio, muunnosasetukset, tuloksen tunniste, tarkistuksen tila, hyväksyjä ja julkaisuaika. Kun lähde muuttuu, merkitse kieliversio tarkistettavaksi sen sijaan, että korvaisit hyväksytyn sisällön hiljaa. Tämä mahdollistaa palautuksen ja tarkastuksen eri alustoilla.

Käyttö ja huolto

Työ ei lopu julkaisuun. Linkitä kieliversio tai kokoonpano sen lähteeseen, seuraa laatu- ja palvelutoimenpiteitä ja määritä konkreettisia tarkistuskäynnistimiä. Triggereitä ovat lähteen muutokset, lakimuutokset, uudet yleisötarpeet, toistuvat tukikysymykset, tekniset muutokset ja tapaukset. Nimetty omistaja arvioi triggerin, avaa tarvittaessa uuden version ja kirjaa uusitun hyväksynnän.

Julkaisun tarkistuslista

  • Integraatiossa käytetään kestäviä lähdetunnisteita.

  • Tunnistetiedot tallennetaan palvelinpuolelle ja niitä kierretään.

  • Aikakatkaisu, uudelleenyritys ja nopeusrajoitus on määritelty.

  • Toistuvat pyynnöt ovat idempotentteja.

  • Luotu sisältö siirtyy tarkistustilaan.

  • Lähteen muutokset mitätöivät version tai avaavat sen uudelleen.

  • Kielinavigointi toimii näppäimistön ja aputekniikan avulla.

  • Valvonta kattaa viat, jonot, latenssin ja vanhentuneen sisällön.

Luotettavat lähteet

  1. Simple8 API -asiakirjat
  2. Simple8 toimitustavat
  3. Verkkosisällön saavutettavuusohjeet (WCAG) 2.2

Ota opas käyttöön

Testaa Simple8:tä edustavalla sisällöllä ja käytä tarkistuslistaa hallitun tuotannon työnkulun suunnitteluun.

Testaa omaa tekstiäsi