Slik bygger du en endringslogg-side: oppføringer, merkelapper, RSS og «Hva er nytt»

En endringslogg-side er en datert liste over hva som har endret seg i produktet ditt, nyeste først, skrevet for dem som bruker det. For å bygge en trenger du oppføringer med dato, en tydelig tittel, en kort forklaring og en merkelapp (Ny, Forbedret, Rettet), en side som lister dem, en egen URL per oppføring, og helst en RSS-feed og en måte å si til brukerne at noe er nytt. Det er en av de enkleste tingene du kan bygge. Hovedvalget er hvor oppføringene skal ligge: som filer på nettstedet, eller i en database med en administrasjonsside.

Hvorfor en endringslogg er verdt det

En endringslogg viser kunder og potensielle kunder at produktet vedlikeholdes. Den gir support og salg en lenke å sende når noen spør «støtter den X ennå?». Den er også et sted å lukke løkken på tilbakemeldinger: når en etterspurt funksjon kommer, er endringsloggoppføringen det du peker folk til. Hvis du driver en tilbakemeldingsportal for kunder, kan du lenke innsendte forespørsler direkte til oppføringene deres.

En endringslogg er ikke din interne commit-historikk. «Refaktorerte faktureringstjenesten» betyr ingenting for en bruker. «Fakturaer viser nå firmaets org.nr.» betyr noe.

Hva siden trenger

Innhold for hver oppføring

Sider

• Endringslogg-indeks: nyeste først, med filtre på merkelapp og enkel paginering eller «last inn flere».
• Oppføringsside: én oppføring per URL, slik at den kan lenkes til og deles.
• RSS- eller Atom-feed: lar folk og verktøy følge oppdateringer uten e-post.
• Administrasjonsside (bare i databaseversjonen): skriv, forhåndsvis, planlegg og publiser oppføringer.

Ekstra i appen

• «Hva er nytt»-merke: en prikk på et menypunkt når det finnes oppføringer brukeren ikke har sett. Lagre datoen for den siste oppføringen de åpnet, per bruker eller i nettleseren.
• E-postoppsummering: en sammenfatning sendt til brukere som har meldt seg på. Dette krever en utsendingsleverandør; se hvordan du sender e-post fra appen din.

Hovedvalget: filer eller database

Oppføringer som filer på nettstedet

Hver oppføring er en Markdown-fil i prosjektet. Å publisere en oppføring betyr å legge til en fil og redeploye. Dette er den enkleste og mest robuste tilnærmingen: ingen database, ingen administratorinnlogging, ingenting å sikre, og sidene kan forhåndsrenderes slik at de laster raskt og er enkle for søkemotorer å lese.

Det passer team der de som skriver oppføringer er komfortable med å be en AI-appbygger om hjelp eller redigere en fil.

Oppføringer i en database med administrasjonsside

Oppføringene ligger i en tabell, og en privat administrasjonsside lar alle på teamet skrive, forhåndsvise, planlegge og publisere. Dette passer team der markedsføring eller support skriver oppdateringer, eller der du vil ha planlagt publisering eller oppføringer per målgruppe (for eksempel bare vise bedriftsfunksjoner til bedriftskunder).

Prisen er mer å bygge og vedlikeholde: en administratorinnlogging, bildeopplastinger, og å sørge for at de offentlige sidene fortsatt kan leses av søkemotorer, noe en side som bare laster oppføringer i nettleseren kanskje ikke kan.

Skriv oppføringer folk leser

• Start med nytten. «Eksporter rapporter til Excel» slår «ny eksportmodul».
• Si hvem som får det. Alle abonnementer, bare Pro, rulles ut denne uken.
• Vis det. Ett skjermbilde eller et kort opptak.
• Gruppér små rettelser. En ukentlig oppføring «Rettelser og forbedringer» med punkter hindrer at siden flommer over.
• Vær ærlig om fjerninger. Hvis noe skal bort, si når og hva man bruker i stedet.

Eksempel på første prompt

Legg til en offentlig endringslogg på nettstedet vårt på /changelog. Hver oppføring er en Markdown-fil med tittel, dato, merkelapp (Ny, Forbedret eller Rettet), valgfritt forsidebilde og brødtekst. Indekssiden lister oppføringene, nyeste først, med dato, merkelapp og første avsnitt, har filterknapper for merkelapper, og viser 10 oppføringer per side. Hver oppføring har sin egen side på /changelog/<slug> med en ordentlig sidetittel og beskrivelse for søkemotorer. Legg til en RSS-feed på /changelog/rss.xml. Lag tre eksempeloppføringer. Tilpass det eksisterende nettstedets design, hold det lesbart på telefoner, og forhåndsrender sidene så de laster raskt.

For databaseversjonen bytter du første setning med «Lagre oppføringer i en database med status utkast/publisert og en publiseringsdato, og legg til en passordbeskyttet administrasjonsside for å skrive, forhåndsvise og publisere dem.»

Byggesteg

1. Velg filer eller database ut fra tabellen over.
2. Bygg indeks- og oppføringssidene med noen få eksempeloppføringer.
3. Legg til merkelapper og filtre.
4. Legg til RSS-feeden og lenk til den fra siden.
5. Legg til sidetitler, beskrivelser og en sitemap-oppføring for hver oppføring. Vår guide om SEO for AI-bygde nettsteder dekker grunnlaget.
6. Administrasjonsside og innlogging, hvis du valgte databaseruten.
7. «Hva er nytt»-merket i appen din.
8. Skriv ekte oppføringer for de siste månedene, så siden ikke er tom ved lansering.

Vanlige feil

• Å kopiere commit-meldinger. Skriv for brukere, ikke utviklere.
• Én stor side uten egne URL-er per oppføring. Ingen kan lenke til en bestemt endring, og søkemotorer ser én side i stedet for mange.
• Oppdateringene stopper etter en måned. En endringslogg som sist ble oppdatert for et år siden tyder på et forlatt produkt. Sett en rytme du klarer å holde.
• Å laste oppføringer bare i nettleseren. Søkemotorer og lenkeforhåndsvisninger kan se en tom side. Forhåndsrender eller render på serveren.
• Å blande inn driftsforstyrrelser. Nedetid hører hjemme på en statusside, ikke i endringsloggen.

Når en ferdig endringsloggtjeneste er det bedre valget

Det finnes hostede verktøy for endringslogg og produktoppdateringer, og noen følger med tilbakemeldingstavler eller widgeter i appen. De er verdt det hvis du vil ha en popup i appen, målretting mot målgrupper og analyse uten å bygge det selv, eller hvis teamet ditt allerede betaler for et verktøy som inkluderer det. Bloggen eller hjelpesenterprogramvaren din har kanskje et passende format allerede.

Bygg din egen når du vil ha endringsloggen på ditt eget domene, i ditt eget design og fullt indekserbar, noe som for en enkel liste med datert innhold ikke er mye arbeid.

Bygge det med Mythex

På Mythex kan du be agenten legge til en endringslogg i et eksisterende prosjekt, eller bygge den som et eget lite nettsted, og se den i live-forhåndsvisningen mens den bygges. Filversjonen trenger ingen database. Hvis du velger administrasjonsversjonen, legger agenten til en dedikert Postgres-database når oppføringer må lagres (eller skriv /database), og skjermbilder legges i prosjektets fillagring. Innlogging for administratoren legger du til selv med din egen autentiseringsløsning (oppskrift for innlogging).

Nye Mythex-apper er ofte klientrenderte enkeltsideapper, og SEO-oppskriften påpeker at de er svakere for søk. Be derfor om statiske eller forhåndsrenderte endringsloggsider hvis du vil at oppføringene skal bli funnet i søk. Samme oppskrift dekker titler, beskrivelser og sitemaps. Som utgangspunkt med en ferdig endringslogg kan du se på produktkunnskapshub-malen.

Spørsmål