CMS ja API

Verkkosivuston widget-opas.

Käytä widgetiä, kun nopea käyttöönotto on tärkeää ja sivusto voi tarjota kestäviä lähdetunnisteita ja helppokäyttöisen kielinavigoinnin.

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

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

Käytä widgetiä, kun nopea käyttöönotto on tärkeää ja sivusto voi tarjota kestäviä lähdetunnisteita ja helppokäyttöisen kielinavigoinnin.

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

Käyttöönottomalli kattaa latauksen, ei-saatavilla olevat versiot, kohdistuksen hallinnan, analytiikan ja ilman komentosarjaa. 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

Varmista, että widget on oikea toimitusmalli

Widget on sopiva, kun isäntäsivusto voi tarjota vakaat lähdetunnisteet, sivuilla on ennustettava sisältörakenne, nopea käyttöönotto on tärkeää ja asiakaspuolen tehostaminen on hyväksyttävää. Se on vähemmän sopiva, kun vaihtoehtoisten versioiden on oltava täysin indeksoituja, niiden on toimittava tiukkojen komentosarjarajoitusten alaisina tai kuuluttava monimutkaiseen todennettuun matkaan. Näissä tapauksissa palvelimen renderöimät sivut tai CMS-integraatio tarjoavat vahvemman hallinnan.

Täytä lyhyt arkkitehtuuripäätöstietue, joka kattaa sisällön omistajuuden, palveluun lähetetyt tiedot, komentosarjan isännöinnin, suostumuksen vaikutukset, sisällön suojauskäytännön, suorituskykybudjetin, selaimen tuen, saavutettavuuden, hakukäyttäytymisen, analytiikan, vikatilan ja ylläpitovastuun. Widgetin on parannettava sivua sen sijaan, että siitä tulisi ainoa reitti olennaiseen tietoon. Alkuperäinen palvelu pysyy käyttökelpoisena, kun komentosarja on estetty, hidas tai ei ole käytettävissä.

KriteeriHyvä widgetin istuvuusSuosi palvelinpuolen toimitusta
KäynnistääHallittu sivusto tarvitsee nopean lisäyksenTarvitaan syvä CMS-työnkulku ja vapautuksen ohjaus
LöytöLähde linkittää selkeästi parannettuun versioonVaihtoehtoinen sivu tarvitsee itsenäisen haun indeksoinnin
JoustavuusLähde on edelleen täydellinen varaosaVaihtoehtoinen versio on välttämätön tehtävän suorittamiseksi
TurvallisuusHyväksytty komentosarjan ja tietovirran sopiva sivustokäytäntöTiukat komentosarjat tai todennetun kontekstin rajoitukset

Lataa asteittain ja suojaa sivun suorituskykyä

Palvele pientä versioittua latauslaitetta hyväksytystä alkuperästä aliresurssien eheydellä, jos käyttöönottomalli tukee sitä. Lataa se viivästyneenä, alusta vasta, kun vastaava säilö on olemassa, ja vältä ensisijaisen sisällön estämistä. Isäntä tarjoaa vakaan sivutunnuksen, lähdeversion, kielen ja sallitut kielitilat validoidun määrityksen kautta. Älä koskaan sijoita API-tunnistetietoja, henkilökohtaisia ​​tietoja tai rajoittamatonta HTML-koodia tietomääritteissä.

Varaa asettelutila säätimille tai lisää ne siirtämättä pääotsikkoa ja tehtävän sisältöä. Aseta suorituskykybudjetit komentosarjan koolle, pyyntöjen määrälle ja vuorovaikutusviiveelle. Keskeytä määritetyn aikakatkaisun jälkeen ja poista latausilmaisimet. Tallenna välimuistiin vain hyväksytyt julkiset tulokset ja näppäile ne lähteen version ja tilan mukaan. Myöhässä oleva tai epäonnistunut widget ei piilota, kopioi tai korvaa lähdesivua.

  1. 1

    Lisää semanttinen palvelimen luoma linkki tai ohjauspaikkamerkki sivun otsikon lähelle.

  2. 2

    Lataa versioitu komentosarja estämättä lähdesisältöä.

  3. 3

    Tarkista isäntäkokoonpano ja pyydä vain hyväksyttyä julkista versiota.

  4. 4

    Renderöi ohjaimia ja sisältöä alkuperäisellä semantiikalla ja ennustettavalla tarkennuksella.

  5. 5

    Raportoi toimintatila lähettämättä tarpeetonta sivun sisältöä tai käyttäjätietoja.

Suunnittele navigointi ja jokainen vikatila

Käytä tavallista linkkiä, kun kieliversiolla on oma osoite. Jos sisältö muuttuu, käytä painiketta, joka nimeää kohdetilan, päivittää asiakirjan otsikon ja pääotsikon tarpeen mukaan, siirtää kohdistusta vain, kun käyttäjä aloitti muutoksen, ja ilmoittaa valmistumisesta tiiviillä tilaviestillä. Säilytä selainhistoria ja tarjoa selkeä reitti takaisin alkuperäiseen. Testaa zoomausta, reflowa, näppäimistöä, näytönlukijaa, suurta kontrastia, vähennettyä liikettä ja käännettyjä tarroja.

Määritä tilat ei-käytettävissä olevalle versiolle, pyynnön aikakatkaisulle, virheellisille määrityksille, estyneelle komentosarjalle, ei-tuetulle selaimelle ja palvelun ylläpitolle. Jokainen osavaltio säilyttää lähteen ja tarjoaa turvallisen seuraavan toimenpiteen. Älä näytä pysyvää kehrää, tyhjää paneelia, raakaa virhekoodia tai säädintä, joka näyttää toimivan mutta jättää sisällön ennalleen. Kun JavaScript on poistettu käytöstä, palvelimen tuottama lähde ja kaikki tunnetut vaihtoehtoisen sivun linkit ovat käytettävissä.

  • Lähdematka pysyy valmiina, kun widget ei koskaan lataudu.

  • Ohjaimet käyttävät alkuperäisiä linkkejä tai painikkeita hyväksytyillä kielitilojen nimillä.

  • Tarkennus- ja tilaviestit ovat ennakoitavissa eivätkä häiritseviä.

  • Jokaisella aikakatkaisulla ja poissaolotilalla on turvallinen seuraava toimenpide.

  • Mikään analytiikka- tai diagnostiikkatapahtuma ei sisällä sivutekstiä tai henkilökohtaisia ​​tietoja tarpeettomasti.

Testaa isäntäympäristöä ja seuraa todellista toimitusta

Testaa edustavia malleja, keskeytyskohtia, selaimia, suostumustiloja, verkkonopeuksia, sisällön suojauskäytäntöjä, tunnisteiden hallintaohjelmia ja aputekniikoita. Sisällytä toistuva alustus, asiakaspuolen navigointi, dynaamisesti lisätty sisältö, tulostus, käännöstarrat, välimuistin vanheneminen, tulos ei saatavilla, aikakatkaisu ja estetty kolmannen osapuolen pyyntö. Varmista, että widget ei luo päällekkäisiä tunnuksia, virheellistä otsikkojärjestystä, kohdistuseroja, asettelun siirtoa tai ristiriitaisia ​​yleisiä tyylejä.

Valvo latauksen onnistumista, version saatavuutta, vasteaikaa, renderöintipoikkeuksia, vanhentuneita lähdeversioita ja käyttäjän aloittamaa tilan valintaa. Näyte isäntämallin ja skriptiversion mukaan, ei henkilökohtaisen identiteetin mukaan. Määritä omistaja, hälytyskynnys, palautusversio ja isäntäviestintäprosessi. Julkaisu hyväksytään, kun lähde pysyy käyttökelpoisena kaikissa simuloiduissa vioissa, kriittiset tehtävät toimivat näppäimistön ja näytönlukuohjelman avulla ja edellinen komentosarjaversio voidaan palauttaa ilman isäntäsivun muutoksia.

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