Değişiklik Günlüğü Sayfası Nasıl Yapılır: Girdiler, Etiketler, RSS ve “Yenilikler”

Değişiklik günlüğü sayfası, ürününüzde neyin değiştiğini, kullanıcılar için yazılmış, en yeniden eskiye tarihli bir listedir. Bir tane yapmak için tarihi, net bir başlığı, kısa bir açıklaması ve bir etiketi (Yeni, Geliştirildi, Düzeltildi) olan girdilere, bunları listeleyen bir sayfaya, girdi başına ayrı bir URL’ye ve ideal olarak bir RSS akışına ve kullanıcılara bir şeyin yeni olduğunu söylemenin bir yoluna ihtiyacınız vardır. En basit yapabileceğiniz şeylerden biridir ve asıl karar girdilerin nerede duracağıdır: sitenizde dosyalar olarak mı, yoksa bir yönetici sayfasıyla bir veritabanında mı.

Değişiklik günlüğü neden değerli

Değişiklik günlüğü, müşterilere ve potansiyel müşterilere ürünün bakımının yapıldığını gösterir. Destek ve satış ekiplerine, “X özelliği var mı?” diye soran birine gönderecekleri bir bağlantı verir. Ayrıca geri bildirimi kapatmanın bir yeridir: istenen bir özellik yayınlandığında, insanlara gösterdiğiniz şey değişiklik günlüğü girdisidir. Bir müşteri geri bildirim portalı işletiyorsanız, yayınlanan istekleri doğrudan kendi girdilerine bağlayın.

Değişiklik günlüğü, iç commit geçmişiniz değildir. Bir kullanıcıya “Faturacılık hizmeti yeniden düzenlendi” hiçbir şey ifade etmez. “Faturalarda artık şirketinizin KDV numarası görünür” ifade eder.

Sayfanın ihtiyaçları

Her girdinin içeriği

Sayfalar

• Değişiklik günlüğü ana sayfası: en yeniden eskiye, etiket filtreleri ve basit sayfalama veya “daha fazla yükle” ile.
• Girdi sayfası: URL başına bir girdi; böylece bağlantı verilebilir ve paylaşılabilir.
• RSS veya Atom akışı: insanların ve araçların e-posta olmadan güncellemeleri takip etmesini sağlar.
• Yönetici sayfası (yalnızca veritabanı sürümünde): girdi yazın, önizleyin, planlayın ve yayınlayın.

Uygulama içi ekstralar

• “Yenilikler” rozeti: kullanıcının görmediği girdiler olduğunda bir menü öğesindeki nokta. Kullanıcının açtığı son girdinin tarihini kullanıcı başına veya tarayıcıda saklayın.
• E-posta özeti: katılan kullanıcılara gönderilen bir özet. Bunun için bir gönderim sağlayıcısı gerekir; bkz. uygulamanızdan e-posta nasıl gönderilir.

Ana karar: dosyalar mı, veritabanı mı

Sitede dosya olarak girdiler

Her girdi projede bir Markdown dosyasıdır. Bir girdiyi yayınlamak, bir dosya eklemek ve yeniden dağıtmak demektir. Bu en basit ve en sağlam yaklaşımdır: veritabanı yok, yönetici girişi yok, güvenli hale getirilecek bir şey yok ve sayfalar önceden derlenebildiği için hızlı yüklenir ve arama motorları tarafından okunması kolaydır.

Girdileri yazan kişilerin bir yapay zekâ oluşturucuya soracak veya bir dosyayı düzenleyecek kadar rahat olduğu ekipler için uygundur.

Yönetici sayfası olan bir veritabanında girdiler

Girdiler bir tabloda durur ve özel bir yönetici sayfası, ekipteki herkesin yazmasını, önizlemesini, planlamasını ve yayınlamasını sağlar. Pazarlama veya destek ekibi güncelleme yazdığında, planlanmış yayınlamaya ihtiyaç duyduğunuzda ya da girdileri kitle başına göstermek istediğinizde uygundur (örneğin kurumsal özellikleri yalnızca kurumsal müşterilere göstermek).

Maliyeti daha fazla geliştirme ve bakım demektir: bir yönetici girişi, görsel yüklemeleri ve herkese açık sayfaların hâlâ arama motorları tarafından okunabilmesini sağlamak; tarayıcıda yalnızca girdi yükleyen bir sayfa bunu sağlamayabilir.

İnsanların okuduğu girdiler yazmak

• Faydayla başlayın. “Raporları Excel’e aktar” “Yeni dışa aktarma modülü”nden iyidir.
• Kimin erişeceğini söyleyin. Tüm planlar, yalnızca Pro, bu hafta kademeli olarak sunuluyor.
• Gösterin. Bir ekran görüntüsü veya kısa bir klip.
• Küçük düzeltmeleri gruplayın. Madde işaretli haftalık bir “Düzeltmeler ve iyileştirmeler” girdisi sayfayı doldurmaktan korur.
• Kaldırmalar konusunda dürüst olun. Bir şey kaldırılacaksa, ne zaman ve yerine ne kullanılacağını söyleyin.

İşe yarayan bir ilk istem

Sitemize /changelog adresinde herkese açık bir değişiklik günlüğü ekle. Her girdi; başlık, tarih, etiket (Yeni, Geliştirildi veya Düzeltildi), isteğe bağlı kapak görseli ve gövdeden oluşan bir Markdown dosyası olsun. Ana sayfa girdileri en yeniden eskiye, tarih, etiket ve ilk paragrafla listelesin, etiket filtre düğmeleri olsun ve sayfa başına 10 girdi göstersin. Her girdinin /changelog/<slug> adresinde, arama motorları için uygun bir sayfa başlığı ve açıklamasıyla kendi sayfası olsun. /changelog/rss.xml adresinde bir RSS akışı ekle. Üç örnek girdi oluştur. Mevcut site tasarımına uysun, telefonlarda okunabilir olsun ve sayfalar hızlı yüklensin diye önceden derlensin.

Veritabanı sürümü için ilk cümleyi şununla değiştirin: “Girdileri taslak/yayında durumu ve yayın tarihiyle bir veritabanında sakla ve yazmak, önizlemek ve yayınlamak için parola korumalı bir yönetici sayfası ekle.”

Yapım adımları

1. Dosyalar mı veritabanı mı, yukarıdaki tabloya göre karar verin.
2. Örnek girdilerle ana sayfayı ve girdi sayfalarını yapın.
3. Etiketleri ve filtreleri ekleyin.
4. RSS akışını ekleyin ve sayfadan bağlayın.
5. Her girdi için sayfa başlıkları, açıklamalar ve site haritası girdisi ekleyin. AI ile yapılan web siteleri için SEO rehberi temelleri kapsar.
6. Yönetici sayfası ve giriş, veritabanı yolunu seçtiyseniz.
7. Uygulamanızda “yenilikler” rozeti.
8. Son birkaç ayın gerçek girdilerini yazın, böylece sayfa boş açılmaz.

Sık yapılan hatalar

• Commit mesajlarını kopyalamak. Kullanıcılar için yazın, geliştiriciler için değil.
• Girdi başına URL’si olmayan tek dev bir sayfa. Kimse belirli bir değişikliğe bağlantı veremez ve arama motorları birçok sayfa yerine tek bir sayfa görür.
• Güncellemeler bir ay sonra duruyor. Bir yıl önce güncellenmiş bir değişiklik günlüğü terk edilmiş bir ürün izlenimi verir. Sürdürebileceğiniz bir ritim belirleyin.
• Girdileri yalnızca tarayıcıda yüklemek. Arama motorları ve bağlantı önizlemeleri boş bir sayfa görebilir. Önceden derleyin veya sunucuda üretin.
• Kesintileri karıştırmak. Kesintiler durum sayfasına aittir, değişiklik günlüğüne değil.

Barındırılan bir değişiklik günlüğü aracı daha iyi seçim olduğunda

Barındırılan değişiklik günlüğü ve ürün güncelleme araçları vardır; bazıları geri bildirim panoları veya uygulama içi widget’larla birlikte gelir. Uygulama içi açılır pencereleri, hedef kitle seçimini ve analitiği kendiniz yapmadan istiyorsanız veya ekibiniz zaten bunu içeren bir araç için ödeme yapıyorsa değerlidirler. Blog veya yardım merkezi yazılımınızın da uygun bir biçimi olabilir.

Kendi değişiklik gününüzü yapmak, değişiklik günlüğünün kendi alan adınızda, kendi tasarımınızla ve tamamen dizine eklenebilir olmasını istediğinizde mantıklıdır; tarihli yazıların basit bir listesi için bu çok fazla iş değildir.

Mythex ile yapmak

Mythex’te, mevcut bir projeye değişiklik günlüğü eklemesini ya da bunu kendi küçük sitesi olarak yapmasını ajandan isteyebilirsiniz; oluşturulurken canlı önizlemede görürsünüz. Dosya tabanlı sürüm veritabanı gerektirmez. Yönetici sürümünü seçerseniz, girdileri kaydetmek gerektiğinde ajan özel bir Postgres veritabanı ekler (veya /database yazın) ve ekran görüntüleri proje dosya depolamasına gider. Yönetici girişi, kendi kimlik doğrulama yönteminizle eklediğiniz bir şeydir (giriş ekleme tarifi).

Yeni Mythex uygulamaları çoğu zaman istemci tarafında oluşturulan tek sayfalık uygulamalardır; SEO tarifi bunların aramada daha zayıf olduğunu belirtir. Girdilerin aramada bulunmasını istiyorsanız statik veya önceden derlenmiş değişiklik günlüğü sayfaları isteyin. Aynı tarif başlıkları, açıklamaları ve site haritalarını kapsar. Yerleşik bir değişiklik günlüğü olan bir başlangıç noktası için ürün bilgi merkezi şablonuna bakın.

Sorular