01
Ürün özeti
Merchant problemi, hedef kullanıcı, ana ekranlar ve başarı metriği tek yerde tutulur.
- Problem tanımı
- Kullanıcı rolleri
- Başarı metriği
Documentation
Shopify app projeleri için anlaşılır dokümantasyon.
Teslim edilen her işin kapsamı, kurulum bilgisi, izinleri ve bakım notları sonradan takip edilebilir olmalı.
Scope
kapsam özeti
QA
test kontrolü
Launch
yayın notları
Kapsam dokümanı
App’in ne yaptığı ve ne yapmadığı açık yazılır.
Kapsam dokümanı proje sırasında karar kaybını azaltır ve teslim kriterlerini netleştirir.
02
Teknik mimari
Shopify API, webhooks, veri modeli, dış servisler ve hosting yaklaşımı belgelenir.
- API izinleri
- Webhook listesi
- Veri akışı
03
Kapsam dışı kararlar
İlk versiyona girmeyen özellikler ayrıca yazılır; sonradan roadmap içinde ele alınır.
- MVP sınırı
- Sonraki faz
- Risk notları
Kurulum ve launch
Yayın süreci tekrar edilebilir hale getirilir.
Projeyi devretmek, test etmek ve App Store review sürecini yönetmek için net adımlar gerekir.
01
Ortam ve secret listesi
Production, preview ve local ortamların ihtiyaç duyduğu değişkenler güvenli biçimde listelenir.
- Env adları
- Yetki seviyesi
- Nerede kullanılır
02
QA kontrol listesi
Admin, storefront, mobil, hata senaryosu ve API limitleri yayın öncesi kontrol edilir.
- Mutlu yol
- Hata yolu
- Mobil görünüm
03
App Store hazırlığı
Listing metinleri, görseller, gizlilik bağlantıları ve demo akışı review öncesi hazırlanır.
- App açıklaması
- Demo adımları
- Privacy linkleri
Bakım notları
Yayından sonra ekip neyi takip edeceğini bilir.
Bakım dokümanı yeni geliştirici, destek ekibi veya mağaza sahibi için canlı referans olur.
01
Monitoring ve log
Hangi hataların kritik olduğu ve nereden izleneceği açıkça belirtilir.
- Log kaynakları
- Alarm kriterleri
- İlk müdahale
02
Versiyonlama
Değişiklik notları, API güncellemeleri ve tema etkileri düzenli takip edilir.
- Release notu
- Geri dönüş planı
- Shopify değişiklikleri
Documentation
Teslim dokümanında bulunması gerekenler
- Kapsam ve kullanıcı akışları
- API izinleri ve webhooks
- Kurulum adımları
- QA ve launch kontrol listesi
Mevcut projenin dokümantasyonu eksik mi?
App’inizi inceleyip teknik kapsam, kurulum ve bakım dokümanını toparlayabiliriz.