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.