Ajan için görev tanımı yazın

İnceleyicinin değerlendirebileceği bir değişiklik açıklayın

‘Müşteri dışa aktarımı ekle’ birkaç kararı açık bırakır. Kayıtları kim dışa aktarabilir? Hangi kayıtlar ve alanlar dâhildir? İstek başarısız olduğunda ne olur? Ajan bu boşlukları makul seçimlerle doldurabilir. Bu seçimler iş açısından yine de yanlış olabilir.

Kullanıcı ve sorunla başlayın. Ardından gerekli davranışı açıklayın. Sonucun kabul edilebilir olup olmadığını gösterecek kanıtı ekleyin.

Görev tanımı, her iç tasarım seçimini sabitlemeden belirsizliği azaltmalıdır. Gerekli veri sınırını belirtin. Değiştirmek için neden yoksa uygulama mevcut kod deposu örüntülerini kullansın.

Somut bir örnek kullanın

Aşağıdaki görev tanımı kurgusal bir destek uygulaması içindir. Eğitim örneğidir; eksiksiz üretim şartnamesi değildir.

Sonuç: Destek yöneticisi müşteri listesini indirebilir.
Aktör: Mevcut kuruluştaki bir yönetici.
Veri: Yalnızca o kuruluştaki aktif müşteriler.
Alanlar: Müşteri kimliği, şirket adı ve hesap durumu.
Biçim: Başlık satırı içeren UTF-8 CSV.
Reddedilen istek: Mevcut yetkilendirme hatasını döndür.
Boş sonuç: Yalnızca başlığı içeren geçerli CSV döndür.
Kapsam: Mevcut dışa aktarım route'unu ve denetim örüntüsünü kullan.
Kapsam dışı: Yeni rol, bağımlılık veya dağıtım yok.
Kanıt: İzin verilen, reddedilen, boş ve kuruluşlar arası istekler için testler.

Bu görev tanımı yararlı davranışı ve sınırları belirler. Başka soruları da açığa çıkarır. Sistem dışa aktarım boyutunu sınırlamalı mı? Bir alan elektronik tablo formülü içerebilir mi? Denetim kaydına kim erişebilir? Önemli sonuçları olan soruları uygulamadan önce çözün. Örneği evrensel kontrol listesi olarak görmeyin.

Gereksinimleri varsayımlardan ayırın

Gereksinim, değişikliğin karşılaması gereken davranışı belirtir. Varsayım henüz doğrulamadığınız bir bilgidir. İkisini ayrı tutun.

Örneğin ‘Mevcut denetim örüntüsünü kullan’ ifadesi uygun bir örüntü olduğunu varsayar. Ajandan onu bulmasını isteyin. Kod deposunda yoksa ajan yeni denetim sistemi uydurmadan önce eksik bağımlılığı bildirmelidir.

Kısıt sonuçla da çelişebilir. Mevcut route tasarımı gereği her kuruluşu döndürebilir. Ajan çelişkiyi göstermeli ve sınırlı düzeltme önermelidir. Veri sınırını sessizce kaldırmamalı veya görevi mimariyi yeniden yazmaya genişletmemelidir.

Tamamlanmaya kanıtı dâhil edin

Son davranışı, değişen kapsamı ve yapılan kontrolleri açıklayan teslim özeti isteyin. Önemli durumlarda tam komutları ve sonuçları isteyin. Geçen kontrolü çalıştırılamayan kontrolden ayırın.

Pull request değişikliğin nedenini korumalıdır. Daha sonra bakım yapan kişi ilk konuşma olmadan kodu görebilir. Dışa aktarımın belirli alanları neden dışarıda bıraktığını ve erişimin nasıl uygulandığını açıklayacak kadar bağlam ekleyin.

Google’ın değişiklik açıklaması rehberi bu kayıt için yararlı referanstır. Açıklama değişikliği ve amacını anlatmalıdır. İnceleme düzeltmelerinden sonra kaydı son uygulamayla uyumlu tutun.

Görev tanımını işle orantılı tutun

Küçük bir metin düzeltmesi kısa görev tanımıyla yapılabilir. Veri dışa aktarımı daha fazla ayrıntı gerektirir çünkü hataları bilgi açığa çıkarabilir. Yeni ödeme iş akışı daha fazla analiz ve inceleme gerektirir.

Görev tanımının kalitesini uzunlukla ölçmeyin. Yetkin bir inceleyicinin doğru sonucu yanlış sonuçtan ayırıp ayıramayacağını sorun. İki makul uygulama önemli bir davranışta farklı sonuç verecekse önce o davranışı netleştirin.