Belge içeriği04 / 16

Temel iş akışı04 / 16

Önemli bir niyet yazın

Bu sayfada

Niyet belgeleri, yazılımın karşılamasını istediğiniz davranışları ve kısıtları kaydeder. Karar verdiklerinizi yazın; uygulamadan ve kanıtlardan öğrendikçe netleştirin. Böylece belge okunabilir kalırken ajana uygulama için alan bırakır.

Korunmaya değer gereksinimleri seçin

Niyet, farklı gereksinim türlerini anlatabilir:

TürÖrnek
Ürün kuralıArt arda 7 gün giriş yaptıktan sonra kullanıcıya bir ödül ver.
Mimari kısıtHer ödeme isteği sunucuda doğrulanmalıdır.
Algoritma gereksinimiAynı girdi ve başlangıç değeri aynı sıralamayı üretmelidir.
Etkileşim gereksinimiKaydetme başarısız olursa kullanıcının girdisini koru ve yeniden denemesine izin ver.

Tetikleyici koşulu ve gözlemlenebilir sonucu anlatın. “Dışa aktarma güvenilir olmalı” ifadesini kontrol etmek zordur. “Dışa aktarma başarısız olursa mevcut filtreleri koru ve yeniden denemeye izin ver” daha açık bir değerlendirme temeli sağlar.

Bir uygulama tercihi, gelecekteki değişikliklerin de ona uymasını gerektirecek kadar önemliyse niyete yazın. Henüz karar vermediğiniz ayrıntılar uygulama tercihi olarak kalabilir.

Kalıcı gereksinimleri bugünkü görevden ayırın

Niyet, yazılımın yapmayı sürdürmesi gerekeni anlatır. İş bitince silinecek bir kontrol listesi değildir. Özellik tamamlandıktan sonra da gereksinimleri koruyun; davranışı değiştirmeye karar verdiğinizde ilgili ifadeleri değiştirin.

Sohbetlerde ayrıca mevcut çalışma turuna ait yönergeler bulunur. Şu ayrımı kullanın:

İçerikYeri
Art arda 7 gün giriş yaptıktan sonra bir ödül ver.Niyet: kalıcı ödül koşulu.
Ödülün iletilmesi başarısız olursa yinelenen ödül vermeden yeniden denemeye izin ver.Niyet: kalıcı hata yönetimi davranışı.
Bu kez ödül mantığını değiştirmeden önce mevcut kodu incele.Geçerli sohbet: bu göreve ait yönerge.
Önce prototipi bitir; görsel tasarımı bir dahaki sefere tartış.Geçerli sohbet: bu çalışma aşamasının planı.

Cümlenin gerçekte neyi kısıtladığını sorun. “Her dışa aktarmadan önce verileri doğrula”, yazılımın işlem sırasını belirler ve niyette yer alır. “Bu kez önce dışa aktarma modülünü araştır”, geçerli görevi düzenler.

Hangi yönergelerin kalıcı gereksinim, hangilerinin yalnızca bu görev için geçerli olduğunu ajana söyleyin. Gerektiğinde göreve özgü önemli yönergeleri yineleyin; yeni bir sohbetin bunları devralacağını varsaymayın.

Belge oluşturun ve düzenleyin

Kenar çubuğunda New Intent (Yeni Niyet) düğmesine tıklayıp bir ad girin. Noea, niyet klasörünün kökünde birinci düzey başlığı olan bir .noea.md dosyası oluşturur.

Belgeler Markdown kullanır; okuma ve düzenleme aynı görünümde yapılır. Düzenlemek için metne tıklayın; başlıklar, listeler, tablolar ve kod bloklarıyla düzenleyin.

Örneğin:

# Günlük girişler

Kullanıcılar günde bir kez giriş yapabilir.

## Ödüller

Art arda 7 gün giriş yaptıktan sonra kullanıcıya bir ödül ver. Aynı seri içinde ödülü yalnızca bir kez ver.

Bölümler için başlık, ayrı gereksinimler için paragraf kullanın. Araştırma, bir listenin tamamını tek içerik parçası olarak ele alır. Konuları bağımsız araştırıp tartışmak istiyorsanız ayrı paragraflara veya bölümlere ayırın.

Niyeti görüşerek geliştirin

Bir kural henüz net değilse ajandan değişiklik önermesini istemeden önce tartışın:

Yinelenen giriş ödüllerini önlemek istiyorum. Burada “yinelenen”in ne anlama geldiğini tanımlamama yardım et ve niyet değişikliği önermeden önce onayımı bekle.

Karara vardığınızda ajandan bunu bir öneriye dönüştürmesini isteyin. İfadeyi inceleyin, gerekirse yeni metni düzenleyin ve kabul edin. Sohbetteki bir ifade, ancak belgeye yazıldığında niyet belgesinin parçası olur.

Ortaya çıkan metin, anladığınız kavramları ve dili kullanmalıdır. Tanımadığınız terimleri veya eklenmiş gereksinimleri tutmaya karar vermeden önce sorun. İyi bir ifade, gereksinimi kendiniz açıklamanızı ve farklı bir davranış istediğinizde değiştirilecek cümleyi bulmanızı sağlar.

Öneriler ve öneri kartları için Niyet değişikliklerini tartışma ve inceleme bölümüne bakın.

İlişkileri göstermek için diyagram kullanın

Dili mermaid olan bir kod bloğu diyagram olarak gösterilebilir. Durum geçişlerini, iş akışlarını veya modüller arasındaki ilişkileri açıklamak için kullanın.

Sağ üstteki denetim diyagramla kaynak metin arasında geçiş yapar. Düzenlemek için kaynağa geçin. Sözdizimi geçersizse veya diyagram türü desteklenmiyorsa Noea kaynağı ve nedenini gösterir; belgenin geri kalanı okunabilir kalır.

Kaydedin ve dış düzenleyicilerle çalışın

macOS'te ⌘S, Windows / Linux'ta Ctrl+S veya File → Save (Dosya → Kaydet) ile elle kaydedin. Başlığın yanındaki nokta kaydedilmemiş değişiklikleri gösterir. Sekme değiştirmek bunları korur; belgeyi veya projeyi kapatırken ya da uygulamadan çıkarken kaydetmeniz istenir.

Kaydetme işlemi Markdown biçimlendirmesini standartlaştırır. Dosyaları dış düzenleyicide de tutabilirsiniz. Siz Noea'da düzenlerken dosya diskte değişirse uygulama doğrudan üzerine yazmak yerine yeniden yükleme veya farklı kaydetme seçenekleri sunar.

İfade değişikliğinin ne anlama geldiğini anlayın

Metin eklemek, değiştirmek ve silmek gereksinimleri farklı şekillerde etkiler:

DüzenlemeAnlamı
“7 gün”ü “14 gün” yapın.Ödülü tetikleyen koşulu değiştirir.
“Aynı seri içinde yalnızca bir kez” ekleyin.Yinelenen ödülleri önleyen bir kısıt ekler.
“Ödül bir rozet olmalıdır” ifadesini kaldırın.Ödülün biçimine ilişkin kısıtı kaldırır.

“Ödül bir rozet olmalıdır” ifadesini kaldırmak, mevcut rozet uygulamasını mutlaka geçersiz kılmaz. Kalan niyeti hâlâ karşılayabilir. Ödülleri bütünüyle kaldırmak için yalnızca biçimlerine ilişkin gereksinimi silmek yerine artık ödül verilmemesi gerektiğini belirtin.

Düzenlemeden önce hangi davranışların değişeceğini ve hangi gereksinimlerin kalması gerektiğini ajana sorun. Yanıtı tartışma temeli olarak kullanın, ardından gerçek uygulamayı ve kanıtları kontrol edin.

Kaydettikten sonra eski açıklamalarda Previous text (Önceki metin) görünür. Yeni gereksinim kod değişikliği gerektiriyorsa araştırmadan önce uygulayın. Yalnızca mevcut davranışı kontrol etmek istiyorsanız doğrudan araştırın.

Uygulama üzerinde bir ajanla çalışma veya Açıklamaları güncel tutma bölümüyle devam edin.