Ürün Ekiplerini Bozmadan Tasarım Sistemi Bileşenlerini Kullanımdan Kaldırmak
Büyük uygulamalarda çığır açan tasarım sistemi değişiklikleri nasıl kullanıma sunulur: anlamsal sürüm oluşturma ve kullanım izlemeyi kullanarak duyurun, kullanımdan kaldırın, codemod'larla taşıyın ve kaldırın.
Ana nokta
Bir bileşeni dört adımda kullanımdan kaldırın: değişikliği nedeni ve değiştirilmesiyle birlikte duyurun, küçük sürümde kullanımdan kaldırılan eski bileşeni net uyarılarla işaretleyin, kılavuzlar ve otomatik kod modlarıyla ekiplerin geçiş yapmasına yardımcı olun ve yalnızca bir sonraki büyük sürümde kaldırın. Her adımda kaç ekranın bu özelliği kullandığını takip edin ve kullanım sıfıra yaklaşana kadar kaldırmayın.
Kullanımdan kaldırma neden yanlış gidiyor
Tasarım sistemi değişiklikleri, ürün ekiplerini şaşırttığında başarısız olur: Bir güncelleme sırasında bir bileşen kaybolur, derlemede kesinti olur ve ekipler eski sürümü sabitleyip yükseltmeyi durdurur. Bu gerçekleştiğinde sistem asıl faydasını, yani tutarlılığını kaybeder çünkü ürünün farklı parçaları farklı versiyonlara sürüklenir.
Dört adımlı bir süreç
Anlamsal sürüm oluşturma basit bir sözleşme sağlar: uyumsuz değişiklikler ana sürüme aktarılır ve bir API'nin bir kısmını kullanımdan kaldırdığınızda, daha sonra kaldırmadan önce belgeleri güncellemeli ve kullanımdan kaldırılmış küçük bir sürümü göndermelisiniz.
- Duyuru: nedenini açıklayın, değişikliği gösterin, bir zaman çizelgesi verin.
- Kullanımdan kaldırma: Kılavuza bağlantı veren bir konsol veya tüy bırakmayan uyarıyla bunu belgelerde ve kodda işaretleyin.
- Geçiş: yazılı bir kılavuz ve kod için kullanımları otomatik olarak güncelleyen bir kod modu sağlayın.
- Kaldır: Bir sonraki büyük sürümde kullanım sıfıra yaklaştığında.
Taşıma işlemini otomatikleştirin
Codemod'lar, kodu bir kod tabanında yeniden yazan komut dosyalarıdır. jscodeshift gibi araçlar, codemod'ları birçok JavaScript veya TypeScript dosyası üzerinde aynı anda çalıştırır, böylece bir nesnenin yeniden adlandırılması veya bileşen değişimi haftalar yerine dakikalar içinde uygulanabilir. Bunları kalan kullanımları işaretleyen tüy bırakmayan kurallarla eşleştirin.
Benimsenmeyi ölçün
Bir bileşeni hâlâ kimin kullandığını bilmeden kaldırmayı planlayamazsınız. Koddaki (içe aktarmalar, tüy bırakmayan uyarılar) ve tasarım dosyalarındaki (tasarım aracınızdaki kitaplık analitiği) kullanımı izleyin. Takımların ilerlemeyi görebilmesi için sayıları yayınlayın ve son birkaç takıma son teslim tarihini zorlamak yerine doğrudan yardımcı olun.
Tasarım tarafını unutmayın
Bileşeni tasarım kitaplığında da kullanımdan kaldırın: "Kullanımdan kaldırıldı" önekiyle yeniden adlandırın, yeni bileşene bağlantı verin ve aramada görünmesini durdurun. Aksi takdirde tasarımcılar bunu yeni çalışmalarında kullanmaya devam ederler ve geçiş asla sona ermez. Hareket ve etkileşim davranışı değişiklik notlarının bir parçası olmalıdır çünkü farklı şekilde hareket eden bir yedek parça, aynı görünse bile bozukmuş hissi verebilir.
Hatırlanacak temel ilkeler
- Duyurun, kullanımdan kaldırın, taşıyın, kaldırın: asla doğrudan kaldırma işlemine atlamayın
- Küçük bir sürümde kullanımdan kaldır; büyük bir sürümde kaldır
- Geçişi otomatikleştirmek için kod modlarını ve tüy bırakmayan kuralları kullanın
- Hem kod hem de tasarım dosyalarındaki kullanımı izleyin
- Sürüm notlarına hareket ve etkileşim değişikliklerini dahil edin
Sık sorulan sorular
Kaynaklar
- Semantic Versioning 2.0.0 — semver.org
- jscodeshift: a JavaScript codemod toolkit — GitHub (Meta)