Näin rakennat muutoslokisivun: merkinnät, tagit, RSS ja ”Mitä uutta”

Muutoslokisivu on päivätty luettelo siitä, mitä tuotteessasi on muuttunut, uusimmasta vanhimpaan, käyttäjille kirjoitettuna. Sen rakentamiseen tarvitset merkintöjä, joissa on päivämäärä, selkeä otsikko, lyhyt selitys ja tagi (Uusi, Parannettu, Korjattu), sivun joka listaa ne, oman URL-osoitteen jokaiselle merkinnälle ja mieluiten RSS-syötteen sekä tavan kertoa käyttäjille, että jotain on uutta. Se on yksi yksinkertaisimmista asioista, joita voit rakentaa, ja pääpäätös on, missä merkinnät elävät: sivuston tiedostoina vai tietokannassa ylläpitosivun kanssa.

Miksi muutoslokista on hyötyä

Muutoslokin avulla asiakkaat ja mahdolliset asiakkaat näkevät, että tuotetta ylläpidetään. Se antaa tuki- ja myyntitiimille linkin, jonka voi lähettää, kun joku kysyy ”osaako tämä vielä X:n?”. Se on myös paikka sulkea palautekierros: kun pyydetty ominaisuus julkaistaan, muutoslokimerkintä on se, mihin osoitat ihmiset. Jos ylläpidät asiakaspalauteportaalia, linkitä toteutetut pyynnöt suoraan niiden merkintöihin.

Muutoslokki ei ole sisäinen committihistoria. ”Laskutuspalvelun refaktorointi” ei merkitse käyttäjälle mitään. ”Laskut näyttävät nyt yrityksesi ALV-numeron” merkitsee.

Mitä sivu tarvitsee

Jokaisen merkinnän sisältö

Sivut

• Muutoslokin etusivu: uusimmat ensin, tagisuodattimet ja yksinkertainen sivutus tai ”lataa lisää”.
• Merkinnän sivu: yksi merkintä per URL-osoite, jotta sen voi linkittää ja jakaa.
• RSS- tai Atom-syöte: antaa ihmisille ja työkaluille mahdollisuuden seurata päivityksiä ilman sähköpostia.
• Ylläpitosivu (vain tietokantaversiossa): kirjoita, esikatsele, ajasta ja julkaise merkintöjä.

Sovelluksen sisäiset lisäosat

• ”Mitä uutta” -merkki: piste valikkokohdan vieressä, kun on merkintöjä, joita käyttäjä ei ole nähnyt. Tallenna sen viimeisimmän avatun merkinnän päivämäärä käyttäjäkohtaisesti tai selaimeen.
• Sähköpostikoonti: yhteenveto, joka lähetetään suostumuksen antaneille käyttäjille. Tämä vaatii lähetyspalveluntarjoajan; katso näin lähetät sähköposteja sovelluksestasi.

Päätös: tiedostot vai tietokanta

Merkinnät sivuston tiedostoina

Jokainen merkintä on Markdown-tiedosto projektissa. Merkinnän julkaiseminen tarkoittaa tiedoston lisäämistä ja uudelleenjulkaisua. Tämä on yksinkertaisin ja kestävin tapa: ei tietokantaa, ei ylläpitokirjautumista, ei suojattavaa, ja sivut voidaan esirenderöidä, jolloin ne latautuvat nopeasti ja hakukoneet lukevat ne helposti.

Se sopii tiimeille, joissa merkintöjä kirjoittavat ihmiset ovat valmiita pyytämään tekoälyrakentajalta tai muokkaamaan tiedostoa.

Merkinnät tietokannassa ylläpitosivulla

Merkinnät elävät taulussa, ja yksityinen ylläpitosivu antaa tiimin jäsenille mahdollisuuden kirjoittaa, esikatsella, ajastaa ja julkaista. Tämä sopii tiimeille, joissa markkinointi tai tuki kirjoittaa päivityksiä, tai kun haluat ajastettua julkaisua tai yleisökohtaisia merkintöjä (esimerkiksi näytä yritysasiakkaille vain yritysominaisuudet).

Hinta on enemmän rakentamista ja ylläpitoa: ylläpitokirjautuminen, kuvien lataus ja varmistus, että julkiset sivut ovat yhä hakukoneiden luettavissa. Sivu, joka lataa merkinnät vain selaimessa, ei välttämättä ole.

Kirjoita merkinnät, jotka ihmiset lukevat

• Aloita hyödystä. ”Vie raportit Exceliin” voittaa ”Uusi vientimoduuli”.
• Kerro, kenelle se kuuluu. Kaikki tilaukset, vain Pro, käyttöönotto tällä viikolla.
• Näytä se. Yksi kuvakaappaus tai lyhyt klippi.
• Ryhmittele pienet korjaukset. Viikoittainen merkintä ”Korjaukset ja parannukset” luettelomuodossa estää sivun tulvimisen.
• Ole rehellinen poistoista. Jos jokin poistuu, kerro milloin ja mitä käyttää sen sijaan.

Esimerkki toimivasta ensimmäisestä kehotteesta

Lisää julkinen muutoslokki sivustollemme osoitteeseen /changelog. Jokainen merkintä on Markdown-tiedosto, jossa on otsikko, päivämäärä, tagi (Uusi, Parannettu tai Korjattu), valinnainen kansikuva ja leipäteksti. Etusivu listaa merkinnät uusimmasta vanhimpaan ja näyttää päivämäärän, tagin ja ensimmäisen kappaleen, sisältää tagisuodatinpainikkeet ja näyttää 10 merkintää sivulla. Jokaisella merkinnällä on oma sivu osoitteessa /changelog/<slug>, jossa on hakukoneille sopiva sivun otsikko ja kuvaus. Lisää RSS-syöte osoitteeseen /changelog/rss.xml. Luo kolme esimerkkimerkintää. Sovita nykyiseen sivuston ulkoasuun, pidä luettavana puhelimella ja esirenderöi sivut, jotta ne latautuvat nopeasti.

Tietokantaversiota varten vaihda ensimmäinen lause seuraavaan: ”Tallenna merkinnät tietokantaan luonnos-/julkaistu-tilalla ja julkaisupäivällä, ja lisää salasanasuojattu ylläpitosivu, jolla merkintöjä voi kirjoittaa, esikatsella ja julkaista.”

Rakennusvaiheet

1. Päätä tiedostot tai tietokanta yllä olevan taulukon perusteella.
2. Rakenna etusivu ja merkinnän sivut muutamalla esimerkkimerkinnällä.
3. Lisää tagit ja suodattimet.
4. Lisää RSS-syöte ja linkitä se sivulta.
5. Lisää sivun otsikot, kuvaukset ja sivukarttamerkintä jokaiselle merkinnälle. Oppaamme SEO tekoälyllä rakennetuille verkkosivuille kattaa perusteet.
6. Ylläpitosivu ja kirjautuminen, jos valitsit tietokantareitin.
7. ”Mitä uutta” -merkki sovelluksessasi.
8. Kirjoita oikeat merkinnät viimeisen muutaman kuukauden ajalta, ettei sivu julkaistessa ole tyhjä.

Yleisimmät virheet

• Committiviestien kopioiminen. Kirjoita käyttäjille, älä kehittäjille.
• Yksi jättisivu ilman merkintäkohtaisia URL-osoitteita. Kukaan ei voi linkittää tiettyyn muutokseen, ja hakukoneet näkevät yhden sivun kymmenien sijaan.
• Päivitykset loppuvat kuukauden jälkeen. Vuoden takaa päivitetty muutoslokki viittaa hylättyyn tuotteeseen. Aseta rytmi, jonka pystyt pitämään.
• Merkintöjen lataaminen vain selaimessa. Hakukoneet ja linkkiesikatselut voivat nähdä tyhjän sivun. Esirenderöi tai renderöi palvelimella.
• Häiriöiden sekoittaminen mukaan. Katkokset kuuluvat tilasivulle, eivät muutoslokkiin.

Milloin hostattu muutoslokityökalu on parempi valinta

Hostattuja muutoslokki- ja tuotepäivitystyökaluja on olemassa, ja jotkin tulevat mukana palautetauluilla tai sovelluksen sisäisillä widgeteillä. Ne kannattavat, jos haluat sovelluksen sisäisen ponnahdusikkunan, yleisökohdennuksen ja analytiikan ilman niiden rakentamista, tai jos tiimisi maksaa jo työkalusta, joka sisältää sellaisen. Blogi- tai ohjekeskusohjelmistosi voi myös tarjota sopivan muodon.

Oman rakentaminen kannattaa, kun haluat muutoslokin omalla verkkotunnuksellasi, omalla ulkoasullasi ja täysin indeksoitavana. Päivättyjen julkaisujen yksinkertaiselle listalle työtä ei tarvita paljon.

Muutoslokin rakentaminen Mythexillä

Mythexissä voit pyytää agenttia lisäämään muutoslokin olemassa olevaan projektiin tai rakentamaan sen omaksi pieneksi sivustoksi, ja näet sen live-esikatselussa rakentamisen aikana. Tiedostopohjainen versio ei tarvitse tietokantaa. Jos valitset ylläpitoversion, agentti lisää oman Postgres-tietokannan, kun merkintöjen tallennus on tarpeen (tai kirjoita /database), ja kuvakaappaukset menevät projektin tiedostotallennukseen. Ylläpitokirjautuminen lisätään omalla todennustavallasi (kirjautumisohje).

Uudet Mythex-sovellukset ovat usein asiakaspuolella renderöityjä yksisivuisia sovelluksia, ja SEO-ohje toteaa, että ne ovat heikompia hakukoneille. Pyydä siksi staattisia tai esirenderöityjä muutoslokisivuja, jos haluat merkintöjen löytyvän hakutuloksista. Sama ohje kattaa otsikot, kuvaukset ja sivukartat. Valmis lähtökohta sisäänrakennetulla muutoslokilla on tuotetiedon keskus -malli.

Kysymykset