Wikipedia:Pendokumenan templat

Daripada Wikipedia, ensiklopedia bebas.
Lompat ke: pandu arah, cari

Templat merupakan satu ciri MediaWiki yang amat berguna, tetapi boleh mengelirukan pengguna baru. Pengguna berpengalaman pun mungkin akan keliru dengan templat yang rumit. Oleh itu templat sepatutnya diiringi oleh "dokumen penerangan" bagi memudahkan penggunaannya.

Dokumentasi templat, sama seperti buku panduan, haruslah menerangkan kegunaan sesebuah templat dan cara-cara menggunakannya. Ia haruslah ditulis dengan mudah supaya seorang pengguna yang tiada pengetahuan penuh selok-belok sintaksis templat, yang kadangkala merangkumi penyunting-penyunting berpengalaman yang mempunyai tumpuan lain, boleh menggunakannya dengan betul. Hal ini amat penting terutamanya yang berkaitan dengan templat yang digunakan dengan meluas.

Apa yang perlu dimasukkan[sunting | sunting sumber]

Pendokumenan sepatutnya merangkumi:

  • Asas tujuan templat: Apa yang ia buat, dan (jika ia tidak serta merta jelas) kenapa ia perlu dibuat. Jika terdapat templat-templat lain yang mempunyai nama atau tujuan yang sama, satu idea yang bagus adalah dengan memperkatakan tentangnya, untuk mengurangkan peluang templat salah digunakan.