Cara mendokumentasikan aturan bisnis

Saya bertanya-tanya apa yang akan menjadi metode formal dan paling umum dilakukan untuk mendokumentasikan aturan bisnis? Juga bagaimana Anda mendokumentasikan spesifikasi UI artefak pengembangan (mis. Mendokumentasikan bidang formulir dan bagaimana tombol berperilaku pada formulir, teks info .. dll)

Untuk aturan bisnis, saya pikir @Joppe menunjuk ke UML yang kita semua pikirkan.

Use Case Diagram melakukan tinjauan excelente tentang bagaimana Aktor / Peran berinteraksi dengan sistem dan apa yang sistem lakukan. Untuk Use Case yang kompleks, info tambahan yang dijelaskan secara tekstual akan banyak membantu ( prakondisi , postkondisi , dependensi pada eksekusi UC sebelumnya , dll )

Ada diagram yang juga melakukan ikhtisar besar bisnis di tingkat yang berbeda:

• State Machine Diagram jika ada jenis negara yang akan didokumentasikan.
• Diagram Aktivitas . Untuk Use Case yang kompleks, Anda mungkin perlu merinci lebih jauh. Tingkat detail terserah Anda dan tergantung pada siapa yang akan membaca dokumentasi. Dokumentasi ini mungkin tidak tampak seperti bisnis, tetapi dengan tingkat perincian yang tepat, bisa jadi demikian.

Hanya sebuah saran, berikan kode untuk setiap Use Case (yaitu: UC-1 , UC-n ). Ini akan berguna nanti, selama dokumentasi UI.

Untuk dokumentasi UI praktik umum (hari ini) adalah melakukan wireframes . Cukup lebih baik daripada tangkapan layar karena terlihat lebih bersih dan sederhana. Misalnya, lihat WireframeSketcher

Wireframes mungkin bukan dokumentasi yang cukup, jadi, untuk setiap layar lakukan pengantar singkat dan jelaskan setiap tombol. Selain itu, lakukan referensi ke UC yang terlibat ke layar ( lihat sekarang mengapa kode UC berguna ). Ini akan membuat dokumentasi Anda koheren.

Intinya alat seperti Wireframesketcher adalah mereka melakukan mockup interaktif. Sempurna untuk memberikan sesuatu yang interaktif kepada pelanggan saat Anda masih merancang atau mengembangkan.

Jangan lupa untuk mendokumentasikan rencana navigasi . Nav Plan tidak memiliki diagram UML, tetapi State Machine Diagram dapat digunakan sebagai gantinya. Ini bukan untuk apa yang dibuat, tapi tetap saja.

Akhirnya ingatlah siapa yang Anda tuju.

• Teknisi : Anda dapat merinci lebih dalam dan menggunakan teknis.

• Bukan Teknisi : hindari teknis (tidak terkait dengan bahasa atau kode). Cobalah untuk menjadi jelas dan sederhana dan gunakan istilah / kata yang sama yang digunakan pelanggan. Pikirkan seperti Anda tidak tahu pemrograman.

Dokumentasi sering dilakukan dalam kasus penggunaan dan bentuk prosa lainnya. Selain itu, akan sangat berguna untuk memiliki diagram UML dan bentuk grafik lainnya yang memberi Anda gambaran umum pada tingkat yang lebih tinggi dan mudah dipahami dalam waktu yang lebih singkat daripada membaca halaman dan halaman.

Dan yang terakhir namun tak kalah pentingnya, dokumentasi terbaik adalah kasus uji yang menjalankan aturan bisnis. Dengan begitu Anda dapat mengubah kode dan mengetahui bahwa Anda melanggar aturan bisnis. Kalau tidak, dokumentasi selalu berada dalam bahaya menjadi basi dan ketinggalan zaman.

Mungkin bentuk yang paling umum adalah Use Cases . Anda dapat melengkapi mereka dengan tiruan layar dan deskripsi.

Sebuah buku yang saya rekomendasikan adalah "Menulis Kasus Penggunaan yang Efektif" oleh Alistair Cockburn. Ini menjelaskan bagaimana Anda dapat menulis kasus penggunaan pada berbagai tingkat detail, cara menghindari jatuh ke pendekatan didorong 'templat', dan hanya menempel pada mendokumentasikan bit yang diperlukan dan relevan.

Apa pun metode yang Anda gunakan, pastikan mereka dapat dipertahankan secara aktif. Mereka harus menjadi dokumen hidup. Menampung dokumen dalam sistem Kontrol Versi atau semacam sistem manajemen dokumen seperti Sharepoint, dapat membantu mempertahankannya. Melacak aturan bisnis melalui dokumen kata yang dilampirkan ke email adalah cara yang mengerikan untuk menangani masalah ini, karena itu mengarah ke beberapa versi yang beredar.

Saya sangat merekomendasikan untuk secara ketat memisahkan aturan bisnis dari spesifikasi sistem dengan hanya merujuk aturan bisnis dari use case dan desain UI. Teknik favorit saya adalah: - Memiliki daftar aturan bisnis yang teridentifikasi dalam spreadsheet. - Dalam desain sistem, gunakan spesifikasi kasus, cerita pengguna atau apa pun, cukup tentukan "Pengguna memasukkan informasi sebagaimana ditentukan dalam aturan bisnis BR012", "Sistem menghitung jumlah total seperti yang ditentukan dalam aturan bisnis BR510". Saya merekomendasikan artikel ini http://www.allaboutrequirements.com/business-rules/

Coba buat diagram UML menggunakan kode studio visual dan plugin Plant UML