Sunday, May 04, 2008

Framework Design Guidelines

Sumber : diskusi milist RPL-IF IT Telkom oleh Yudi Maryanto :

Ada beberapa panduan bagus dalam medesain framework di buku Framework Design Guidelines:
1.Gunakan Aggregate Component untuk menyederhanakan public interface pada skenario yang paling sering digunakan.

2. Pegang teguh prinsip "Make the top scenarios easy and the rest is possible". Jadi meskipun public interface kita sederhana untuk skenario yang paling umum, developer yang butuh skenario yang lebih rumit bisa mengeksplore lebih jauh framework kita.

3. Usahakan framework yang kita buat bersifat "Self Documenting". Pada skenario yang paling umum, usahakan developer tidak perlu melihat dokumentasi untuk melakukannya. Hal ini bisa dicapai dengan penamaan kelas dan method yang intuitif.

4. Buat framework kita konsisten sehingga jika developer telah menguasai sebagian framework kita, pengetahuan tersebut tetap bisa dipakai dalam mempelajari bagian lain dari framework kita.

5. Usahakan jangan mengekspose design pattern untuk public interface pada skenario yang paling umum. Konsep-konsep OOAD, design pattern, dll cocok diterapkan untuk detail implementasi framework kita tapi kurang cocok untuk public interface karena cenderun akan memperumit interface yang pada akhirnya akan membuat frustasi developer.

No comments: