İş kuralları nasıl belgelenir

İş kurallarını belgelemenin resmi ve en çok uygulanan yönteminin ne olacağını merak ediyorum? Ayrıca geliştirme yapay nesnelerinin kullanıcı arabirimi özelliklerini nasıl belgelersiniz (örn. Form alanlarını belgelendirme ve düğmelerin form, bilgi metni vb. Üzerinde nasıl davrandığı)

İş kuralları için, @Joppe hepimizin düşündüğümüz UML'ye işaret ettiğini düşünüyorum.

Vaka Diyagramlarını Kullan, Aktörlerin / Rollerin sistemle nasıl etkileşime girdiğine ve sistemin ne yaptığına dair mükemmel bir genel bakış yapar. Complexe Use Case için ek bilgi çok yardımcı olacaktır metinsel olarak açıklanmış ( ön koşulların , Hedefşartlar , önceki UC yürütmeler üzerinde bağımlılıklar , vb )

İşletmenin farklı düzeylerde mükemmel bir şekilde gözden geçirilmesini sağlayan diyagramlar vardır:

• Belgelenecek herhangi bir durum varsa Makine Şemasını belirtin .
• Faaliyet Şeması . Karmaşık Kullanım Durumu için ayrıntıların derinliklerine gitmeniz gerekebilir. Ayrıntıların seviyesi size bağlıdır ve belgeleri kimin okuyacağına bağlıdır. Bu, iş benzeri belgeler gibi görünmeyebilir, ancak doğru düzeyde ayrıntılarla bu hale gelebilir.

Sadece bir tavsiye, her Kullanım Durumuna bir kod atayın (örn: UC-1 , UC-n ). Bunlar daha sonra kullanıcı arayüzü dokümantasyonunda faydalı olacaktır.

UI dokümantasyonu için ortak uygulama (bugünlerde) tel kafesler yapmaktır . Ekran çekimlerinden çok daha iyi çünkü daha temiz ve basit görünüyor. Örneğin, WireframeSketcher'a bir göz atın

Tel kafesler yeterli dokümantasyon olmayabilir, bu nedenle her ekran için kısa bir giriş yapın ve her düğmeyi açıklayın. Ayrıca, ekranda yer alan UC'ye referanslar yapın ( şimdi UC kodlarının neden yararlı olduğuna bakın ). Bu, belgelerinizi tutarlı hale getirecektir.

Wireframesketcher gibi araçların amacı interaktif maketler yapmalarıdır. Hala tasarlarken veya geliştirirken müşteriye etkileşimli bir şey vermek için mükemmeldir.

Navigasyon planını belgelemeyi unutmayın . Nav. Planın UML diyagramı yoktur, bunun yerine Durum Makinesi Diyagramı kullanılabilir. Yapıldığı şey için değil, yine de.

Sonunda kime hitap ettiğinizi unutmayın.

• Teknisyen : Detaylara inebilir ve teknik özellikleri kullanabilirsiniz.

• Teknisyen değil : tekniklerden kaçının (ne dil ne de kodla ilgili). Açık ve basit olmaya çalışın ve müşterinin kullandığı terimleri / kelimeleri kullanın. Programlama hakkında hiçbir fikriniz olmadığını düşünün.

Dokümantasyon genellikle kullanım durumlarında ve diğer düzyazı formlarında yapılır. Buna ek olarak, daha yüksek bir seviyeye genel bir bakış sağlayan ve sayfaları ve sayfaları okumaktan daha kısa sürede anlaşılması kolay olan UML diyagramlarına ve diğer grafik formlara sahip olmak son derece yararlı olabilir.

Ve son fakat en az değil, en iyi belgeler imho iş kurallarını uygulayan test durumlarıdır. Bu şekilde kodu değiştirebilir ve bir iş kuralını ihlal ettiğinizi öğrenebilirsiniz. Aksi takdirde dokümantasyon her zaman bayat ve güncelliğini kaybetme tehlikesi altındadır.

Muhtemelen en yaygın biçim Kullanım Durumlarıdır . Bunları ekran maketleri ve açıklamalarıyla tamamlayabilirsiniz.

Tavsiye edebileceğim bir kitap Alistair Cockburn'ün "Etkili Kullanım Durumlarını Yazmak" tır. Kullanım örneklerini çeşitli ayrıntı düzeylerinde nasıl yazabileceğinizi, 'şablon' güdümlü yaklaşıma düşmekten nasıl kaçınacağınızı ve sadece gerekli ve ilgili bitleri belgelemeye nasıl bağlı kalacağınızı açıklar.

Hangi yöntemi kullanırsanız kullanın, bunların aktif olarak korunabildiğinden emin olun. Yaşayan belgeler olmalılar. Belgeleri bir Sürüm Kontrol sistemine veya Sharepoint gibi bir çeşit belge yönetim sistemine yerleştirmek, bunların bakımını yapma konusunda çok yol kat edebilir. E-postalara ekli kelime belgeleri aracılığıyla iş kurallarını takip etmek, sorunla başa çıkmak için korkunç bir yoldur, çünkü etrafta birden fazla sürüm ortaya çıkar.

İş kurallarını yalnızca kullanım senaryosundan ve kullanıcı arayüzü tasarımından bahsederek iş kurallarını sistem şartnamesinden kesinlikle ayırmanızı tavsiye ederim. En sevdiğim teknik: - Bir e-tabloda belirlenmiş iş kurallarının bir listesini bulundurun. - Sistem tasarımında, vaka belirtimi, kullanıcı öyküleri ya da her neyse kullanın, "Kullanıcı BR012 iş kuralı ile belirtilen bilgileri girer", "Sistem, BR510 iş kuralı ile belirtilen toplam tutarı hesaplar" seçeneğini belirtin. Bu makaleyi tavsiye ederim http://www.allaboutrequirements.com/business-rules/

Visual studio kodu ve Plant UML eklentisini kullanarak UML diyagramı oluşturmayı deneyin