CMS u API

Gwida ta 'implimentazzjoni WordPress.

Agħżel il-widget jew il-kunsinna API deliberatament, żomm il-paġna oriġinali kanonika, u ppubblika verżjonijiet tal-lingwa permezz ta' reviżjonijiet.

Iċċara l-kompitu u d-deċiżjoni

Din il-gwida ddawwar il-gwida ta 'implimentazzjoni wordpress fi fluss tax-xogħol operattiv li jista' jiġi rivedut. Tgħaqqad id-deċiżjonijiet tad-dominju, is-sjieda, l-evidenza u l-aċċettazzjoni sabiex ir-riżultat ikompli jaħdem fil-produzzjoni.

Agħżel il-widget jew il-kunsinna API deliberatament, żomm il-paġna oriġinali kanonika, u ppubblika verżjonijiet tal-lingwa permezz ta' reviżjonijiet.

Proċess prattiku

  1. 1

    Tipi ta 'sors ta' inventarju, identifikaturi, oqsma, lokalitajiet, sidien, u stati ta 'pubblikazzjoni.

  2. 2

    Agħżel il-mudell tal-kunsinna minn volum, latency, kontroll editorjali, u tolleranza ta 'falliment.

  3. 3

    Immappja r-rekord tas-sors għal rekord separat tal-verżjoni tal-lingwa b'rabta durabbli.

  4. 4

    Żid awtentikazzjoni, idempotenza, ipprova mill-ġdid, invalidazzjoni tal-cache, illoggjar, u kontrolli tal-aċċess.

  5. 5

    Pubblikazzjoni tat-test, bidliet fis-sors, riżultati mhux disponibbli, rollback, tħaddim tat-tastiera, u monitoraġġ qabel ir-rilaxx.

Eżempju jew għodda

Fluss tax-xogħol ta' Gutenberg jimmappa paġni tas-sors, stati ta' reviżjoni, ċwievet tal-cache, u navigazzjoni tal-lingwa. Fl-għodda, irreġistra wkoll il-linja bażi, is-sid, id-deċiżjoni, l-evidenza, il-ħruġ miftuħ u d-data tal-approvazzjoni. Uża paġna jew transazzjoni reali sabiex it-tim jara dipendenzi, eċċezzjonijiet, u x-xogħol ta 'manutenzjoni li jsegwi r-rilaxx.

Punt tad-deċiżjoniRekordKriterju ta' aċċettazzjoni
Linja bażiStat attwali osservatSors u data rreġistrati
DeċiżjoniGħażla magħżula u raġuniRiskju u udjenza kkunsidrati
EvidenzaTest, dokument, jew kejlRivedibbli u speċifiku għall-verżjoni
ApprovazzjoniIsem, rwol, u dataIl-kriterji obbligatorji kollha sodisfatti

Agħżel widget, plugin, jew konsenja API min-naħa tas-server

Uża widget meta l-veloċità tal-iskjerament tkun importanti, il-paġni tas-sors diġà għandhom identifikaturi durabbli, u dipendenza fuq in-naħa tal-klijent hija aċċettabbli. Uża plugin WordPress meta l-edituri jeħtieġu ġenerazzjoni u reviżjoni ġewwa l-interface tal-amministrazzjoni. Uża l-konsenja API min-naħa tas-server meta l-verżjonijiet tal-lingwa jridu jiġu indiċjati, fil-cache, inklużi fil-feeds, u mogħtija anki meta JavaScript ma jkunx disponibbli. Pubblikaturi kbar ħafna drabi jikkombinaw plugin għall-fluss tax-xogħol ma ' rendering fuq is-server għall-kunsinna.

Iddokumenta l-għażla kontra l-kontroll editorjali, il-prestazzjoni, l-aċċessibbiltà, it-tfittxija, l-imġieba ta’ falliment, il-fluss tad-dejta, u s-sjieda tal-manutenzjoni. Il-paġna oriġinali tibqa’ s-sors awtorevoli. Verżjoni tal-lingwa tikseb post tagħha stess jew rekord strutturat, URL stabbli, status ta 'reviżjoni, u link ta' reviżjoni tas-sors. Evita li taħżen kontenut alternattiv biss f'qasam tad-dwana mhux verżjonat jew cache tal-brawżer minħabba li r-reviżuri ma jistgħux japprovawh, jirrestawraw jew jivverifikawh b'mod affidabbli.

MudellL-aħjar tajbinKontroll primarju
WidgetŻieda mgħaġġla għal sit ikkontrollatStat ta' riżerva u falliment aċċessibbli
Fluss tax-xogħol tal-pluginL-edituri jaħdmu kompletament f'WordPressRwoli, nonces, kapaċitajiet, u reviżjonijiet
API fuq in-naħa tas-serverPaġni indiċjati, cacheable, reżiljentiKju, invalidazzjoni tal-cache, u operazzjonijiet ta' skjerament

Mudell tar-relazzjonijiet tas-sors u l-istati editorjali

Oħloq tip ta' post tal-verżjoni tal-lingwa jew uża struttura multilingwi li tappoġġja relazzjonijiet espliċiti tas-sors. Aħżen l-ID tal-post tas-sors, l-ID tar-reviżjoni tas-sors, il-lokal fil-mira, il-mod tal-lingwa, l-ID tar-riżultat, il-verżjoni tal-glossarju, l-istatus tar-reviżjoni, l-approvazzjonijiet, ir-reviżjoni ppubblikata u l-iskattar tar-reviżjoni. Żomm l-istruttura tal-blokk trasformata fejn possibbli sabiex l-intestaturi, il-listi, il-links, it-tabelli u l-avviżi jibqgħu semantiċi aktar milli jiġu ċċattjati f'qasam HTML wieħed.

Iddefinixxi l-istatus għal mitluba, ġenerazzjoni, abbozz, reviżjoni tas-suġġett, reviżjoni tal-lingwa, approvat, ippubblikat, skadut, u fallut. Map kull transizzjoni għal kapaċità WordPress, mhux biss buttuna viżibbli. Ġeneratur jista' joħloq abbozz iżda ma jistax japprovah. Meta s-sors jinbidel, qabbel ir-reviżjoni tiegħu mar-reviżjoni tas-sors approvata u ċċaqlaq il-verżjoni tal-lingwa għal skadenza jew reviżjoni meħtieġa. Tippubblikax fis-skiet riżultat riġenerat.

  1. 1

    Irreġistra r-rekord tal-verżjoni tal-lingwa u l-metadejta meħtieġa b'permessi ta' sanitizzazzjoni u REST.

  2. 2

    Mappa blokki Gutenberg appoġġjati u tiddefinixxi l-imġiba għal blokki mhux appoġġjati.

  3. 3

    Ikkonfigura r-rwoli u t-tranżizzjonijiet tal-istatus permessi.

  4. 4

    Iġġenera f'reviżjoni separata u tippreżenta paragun tas-sors.

  5. 5

    Ippubblika biss wara l-approvazzjonijiet meħtieġa għal-livell tar-riskju tal-kontenut.

Cache b'mod sikur u jipprovdu navigazzjoni tal-lingwa dejjiema

Ibni ċwievet tal-cache mis-sit, l-ID tal-post tas-sors, ir-reviżjoni tas-sors, il-lokal, il-mod tal-lingwa, u l-verżjoni tar-renderer. Invalida l-paġna tal-lingwa relatata meta tinbidel ir-reviżjoni approvata tagħha, tinbidel is-sors tagħha, tinbidel blokka kondiviża, jew tiġi ppubblikata mill-ġdid regola ta’ terminoloġija rilevanti. Jekk l-ipproċessar jaħdem b'mod mhux sinkroniku, agħti l-aħħar verżjoni approvata waqt li l-abbozz il-ġdid jiġi rivedut. Qatt tissostitwixxi kontenut approvat bi stat vojt għax il-ġenerazzjoni mhix disponibbli.

Żid links tal-lingwa bħala ankri ordinarji mogħtija minn server b'ismijiet ċari bħal 'Kitba Ċara' u 'faċli biex tinqara u tinftiehem'. Inkludi links reċiproċi għall-paġna tas-sors u kkoreġi metadejta b'lingwa alternattiva. Ippreserva l-fokus tat-tastiera wara swiċċ fil-paġna, u ħabbar bidla fir-rotta biss permezz tat-titlu u l-intestatura tal-paġna normali. Verżjoni nieqsa għandha tispjega li mhix disponibbli u torbot lura mas-sors, mhux taħbi l-kontroll jew loop lura fis-skiet.

  • Iċ-ċwievet tal-cache jinkludu verżjonijiet tas-sors u tar-renderer.

  • L-aħħar paġna approvata tibqa' ħaj API u qtugħ fil-kju.

  • Ir-rabtiet lingwistiċi jaħdmu mingħajr JavaScript u jużaw terminoloġija approvata.

  • Metadata kanonika u alternattiva tirrifletti r-relazzjoni attwali.

  • Bidliet ta' blokk kondiviż u glossarju jikkawżaw kompiti ta' reviżjoni affettwati.

Ittestja t-triq sħiħa tal-pubblikazzjoni u t-tkeċċija

Uża kopja ta' staging bi blokki Gutenberg rappreżentattivi, oqsma tad-dwana, formoli inkorporati, blokki li jistgħu jerġgħu jintużaw, u postijiet ristretti. Ġenerazzjoni tat-test, infurzar tar-rwoli, kummenti ta' reviżjoni, pubblikazzjoni skedata, preview, invalidazzjoni tal-cache, aġġornament tas-sors, immarkar skadut, tħassir, restawr, u rollback. Ikkonferma li l-endpoints REST jirrifjutaw qari u kitbiet mhux awtorizzati u li l-impjiegi fl-isfond ma jistgħux jiġu attivati ​​bejn is-sit mingħajr kredenzjali validi ta' nonce jew server.

Qabel il-produzzjoni, iddefinixxi l-monitoraġġ tal-kju, is-sjieda tal-iżbalji, ir-rotazzjoni tal-kredenzjali, l-ittestjar tal-aġġornament tal-plugin, il-backup tad-database, u proċedura sikura ta 'diżattivazzjoni. L-aċċettazzjoni teħtieġ rendering korrett f'punti ta' waqfien komuni, navigazzjoni bit-tastiera u l-iskrin-reader, l-ebda bidla fit-tqassim minn kontenut tard, intestaturi strutturati validi, approvazzjoni traċċabbli, u restawr tal-aħħar reviżjoni approvata. Irreġistra l-WordPress appoġġjati, PHP, editur, plugin multilingwi, u konfigurazzjonijiet tal-caching.

Rwoli, evidenza, u approvazzjoni

Żomm il-ġenerazzjoni separata mill-pubblikazzjoni. Reazzjoni b'suċċess hija abbozz, mhux approvazzjoni. Aħżen l-identifikatur tas-sors u l-verżjoni, is-settings tat-trasformazzjoni, l-identifikatur tar-riżultat, l-istat tar-reviżjoni, l-approvazzjoni, u l-ħin tal-pubblikazzjoni. Meta s-sors jinbidel, immarka l-verżjoni tal-lingwa għal reviżjoni minflok ma tissostitwixxi bil-kwiet il-kontenut approvat. Dan jagħmel ir-rollback u l-awditjar possibbli fuq il-pjattaformi kollha.

Operazzjonijiet u manutenzjoni

Ix-xogħol ma jispiċċax mal-pubblikazzjoni. Qabbad il-verżjoni tal-lingwa jew il-konfigurazzjoni mas-sors tagħha, timmonitorja l-kwalità u l-miżuri tas-servizz, u ddefinixxi l-kawżi konkreti tar-reviżjoni. It-tqanqil jinkludu bidliet fis-sors, bidliet legali, ħtiġijiet ġodda ta 'udjenza, mistoqsijiet ta' appoġġ rikorrenti, bidliet tekniċi, u inċidenti. Sid imsemmi jevalwa l-grillu, jiftaħ reviżjoni ġdida meta jkun meħtieġ, u jirreġistra approvazzjoni mġedda.

Lista ta' kontroll għall-pubblikazzjoni

  • L-integrazzjoni tuża identifikaturi tas-sors durabbli.

  • Il-kredenzjali huma maħżuna fuq in-naħa tas-server u mdawra.

  • Il-timeout, il-prova mill-ġdid, u l-imġieba tal-limitu tar-rata huma definiti.

  • Talbiet ripetuti huma idempotenti.

  • Il-kontenut iġġenerat jidħol fi stat ta' reviżjoni.

  • Il-bidliet fis-sors jinvalidaw jew jerġgħu jiftħu l-verżjoni.

  • In-navigazzjoni lingwistika taħdem bit-tastiera u t-teknoloġija assistiva.

  • Il-monitoraġġ ikopri fallimenti, kjuwijiet, latency, u kontenut mhux użat.

Sorsi awtorevoli

  1. Simple8 API dokumentazzjoni
  2. Mudelli ta 'kunsinna Simple8
  3. Linji Gwida għall-Aċċessibilità tal-Kontenut tal-Web (WCAG) 2.2

Poġġi l-gwida fil-prattika

Ittestja Simple8 b'kontenut rappreżentattiv u uża l-lista ta 'kontroll biex tippjana fluss tax-xogħol ta' produzzjoni kkontrollat.

Ittestja t-test tiegħek