Nothing Special   »   [go: up one dir, main page]

Pergi ke kandungan

Bantuan:Mendokumenkan templat dan modul

Daripada Wikikamus

Templat dan modul ialah ciri MediaWiki yang sangat berkuasa, tetapi boleh mengelirukan pengguna baharu, malahan pengguna berpengalaman juga boleh mengalami kesukaran untuk memahami kod-kod yang lebih kompleks. Oleh itu, semua templat dan modul harus disertakan pendokumenan untuk meningkatkan kebolehgunaan.

Pendokumenan harus menerangkan perkara yang dilakukan oleh templat atau modul dan cara menggunakannya. Untuk templat khususnya, ia sepatutnya cukup mudah untuk pengguna tanpa pengetahuan lengkap tentang selok-belok sintaks templat (juga merangkumi ramai penyumbang berpengalaman yang menumpukan perhatian mereka di tempat lain) boleh menggunakannya dengan cara betul. Hal ini memang benar terutamanya apabila sesuatu templat itu digunakan secara meluas.