Så bygger du en changelog-sida: poster, taggar, RSS och "Nytt"

En changelog-sida är en daterad lista över vad som ändrats i din produkt, nyaste först, skriven för de personer som använder den. För att bygga en behöver du poster med ett datum, en tydlig titel, en kort förklaring och en tagg (Nytt, Förbättrat, Åtgärdat), en sida som listar dem, en separat URL per post och helst ett RSS-flöde och ett sätt att berätta för användare att något är nytt. Det är en av de enklaste sakerna du kan bygga, och det viktigaste beslutet är var posterna ska ligga: som filer på din sajt, eller i en databas med en administrationssida.

Varför en changelog är värd besväret

En changelog visar för kunder och prospekt att produkten underhålls. Den ger support och försäljning en länk att skicka när någon frågar "kan den här göra X än?". Den är också ett sätt att stänga återkopplingsloopen: när en efterfrågad funktion lanseras är changelog-posten det du hänvisar till. Om du driver en portal för kundåterkoppling, länka levererade önskemål direkt till deras poster.

En changelog är inte din interna commit-historik. "Refaktoriserade faktureringstjänsten" betyder ingenting för en användare. "Fakturor visar nu ditt företags momsnummer" betyder något.

Vad sidan behöver

Innehåll för varje post

Sidor

• Changelog-index: nyaste först, med taggfilter och enkel paginering eller "visa fler".
• Postsida: en post per URL, så att den kan länkas och delas.
• RSS- eller Atom-flöde: låter folk och verktyg följa uppdateringar utan e-post.
• Administrationssida (endast databasversionen): skriva, förhandsgranska, schemalägga och publicera poster.

Extra i appen

• "Nytt"-markering: en prick på en menypost när det finns poster användaren inte sett. Lagra datumet för den senaste post användaren öppnat, per användare eller i webbläsaren.
• E-postsammanfattning: en sammanfattning som skickas till användare som valt det. Detta kräver en utskickstjänst; se hur du skickar e-post från din app.

Det stora beslutet: filer eller databas

Poster som filer på sajten

Varje post är en Markdown-fil i projektet. Att publicera en post innebär att lägga till en fil och driftsätta på nytt. Det här är det enklaste och mest robusta sättet: ingen databas, ingen administratörsinloggning, inget att säkra, och sidorna kan förrenderas så att de laddas snabbt och är lätta för sökmotorer att läsa.

Det passar team där de som skriver poster är bekväma med att be en AI-byggare om något eller redigera en fil.

Poster i en databas med administrationssida

Posterna ligger i en tabell, och en privat administrationssida gör det möjligt för vem som helst i teamet att skriva, förhandsgranska, schemalägga och publicera. Detta passar team där marknad eller support skriver uppdateringar, eller där du vill ha schemalagd publicering eller poster per målgrupp (till exempel att bara visa funktioner för företagskunder för företagskunder).

Kostnaden är mer att bygga och underhålla: en administratörsinloggning, bilduppladdningar och att se till att de publika sidorna fortfarande kan läsas av sökmotorer, vilket en sida som bara laddar poster i webbläsaren kanske inte klarar.

Skriva poster som folk läser

• Börja med nyttan. "Exportera rapporter till Excel" slår "Ny exportmodul".
• Säg vem det gäller. Alla abonnemang, endast Pro, rullas ut den här veckan.
• Visa det. En skärmbild eller ett kort klipp.
• Gruppera små åtgärder. En veckovis post "Åtgärder och förbättringar" med punkter gör att sidan inte översvämmas.
• Var ärlig om borttagningar. Om något försvinner, säg när och vad man ska använda i stället.

En första prompt som fungerar

Lägg till en publik changelog på vår sajt på /changelog. Varje post är en Markdown-fil med titel, datum, tagg (Nytt, Förbättrat eller Åtgärdat), valfri omslagsbild och brödtext. Indexsidan listar posterna nyaste först med datum, tagg och första stycket, har knappar för taggfilter, och visar 10 poster per sida. Varje post har en egen sida på /changelog/<slug> med en riktig sidtitel och beskrivning för sökmotorer. Lägg till ett RSS-flöde på /changelog/rss.xml. Skapa tre exempelposter. Matcha sajtens befintliga design, håll den läsbar på telefoner och förrendera sidorna så att de laddas snabbt.

För databasversionen, byt första meningen mot "Lagra poster i en databas med status för utkast/publicerad och ett publiceringsdatum, och lägg till en lösenordsskyddad administrationssida för att skriva, förhandsgranska och publicera dem."

Byggsteg

1. Bestäm filer eller databas med hjälp av tabellen ovan.
2. Bygg index- och postsidorna med några exempelposter.
3. Lägg till taggar och filter.
4. Lägg till RSS-flödet och länka till det från sidan.
5. Lägg till sidtitlar, beskrivningar och en sitemap-post för varje post. Vår guide om SEO för AI-byggda webbplatser täcker grunderna.
6. Administrationssida och inloggning, om du valt databasvägen.
7. "Nytt"-markering i din app.
8. Skriv riktiga poster för de senaste månaderna så att sidan inte lanseras tom.

Vanliga misstag

• Att kopiera commit-meddelanden. Skriv för användare, inte för utvecklare.
• En enda jättelik sida utan poster med egna URL:er. Ingen kan länka till en specifik ändring, och sökmotorer ser en sida i stället för många.
• Uppdateringarna upphör efter en månad. En changelog som senast uppdaterades för ett år sedan antyder en övergiven produkt. Sätt en rytm du kan hålla.
• Att bara ladda poster i webbläsaren. Sökmotorer och förhandsvisningar av länkar kan se en tom sida. Förrendera eller rendera på servern.
• Att blanda in incidenter. Driftstörningar hör hemma på en statussida, inte i changelogen.

När ett färdigt changelog-verktyg är det bättre valet

Det finns färdiga verktyg för changelog och produktuppdateringar, och vissa följer med återkopplingstavlor eller widgetar i appen. De är värda det om du vill ha en popup i appen, målgruppsstyrning och analys utan att bygga dem själv, eller om ditt team redan betalar för ett verktyg som innehåller en. Din bloggs eller hjälpcentrets programvara kan också ha ett lämpligt format redan.

Att bygga din egen är meningsfullt när du vill ha changelogen på din egen domän, i din egen design och helt indexerbar, vilket för en enkel lista med daterade inlägg inte är mycket arbete.

Bygga den med Mythex

På Mythex kan du be agenten lägga till en changelog i ett befintligt projekt eller bygga den som en egen liten sajt, och se den i den levande förhandsgranskningen medan den byggs. Filbaserade versionen behöver ingen databas. Om du väljer administrationsversionen lägger agenten till en dedikerad Postgres-databas när poster behöver sparas (eller skriv /database), och skärmbilder läggs i projektets fillagring. Inloggning för administratörer är något du lägger till med din egen autentiseringsmetod (recept för inloggning).

Nya Mythex-appar är ofta klientrenderade single-page-appar, vilket SEO-receptet noterar är svagare för sök, så be om statiska eller förrenderade changelog-sidor om du vill att poster ska hittas i sök. Samma recept täcker titlar, beskrivningar och sitemaps. Som utgångspunkt med en inbyggd changelog, se mallen produktkunskapshubb.

Frågor