עריכת הדף "עזרה:תבניות" (פסקה)

==תיעוד תבנית==

חלק בלתי נפרד מיצירת תבנית הוא ה[[הנדסת תוכנה|תיעוד]] שלה, שכן ללא תיעוד, לא ידעו כיצד להשתמש בה. בעיה זו מחריפה ככל שהתבנית יותר מורכבת (בדרך כלל, בהתאם למספר הפרמטרים שבה). אם נתקלתם בתבנית ללא תיעוד, ניתן לשאול ב[[חב"דפדיה:דף שיחה|דף השיחה]] של התבנית או לפנות אל יוצר התבנית (חפשו את שמו ב[[חב"דפדיה:דף גרסאות קודמות|דף "גרסאות קודמות"]]) בבקשה שיכתוב תיעוד.

התיעוד נחלק לתיעוד עבור המתכנת, המסביר את הקוד ומשולב בתוכו כ[[עזרה:הערה מוסתרת|הערות מוסתרות]] (ראו סעיף "[[#הערה מוסתרת בתבנית|הערה מוסתרת בתבנית]]") ותיעוד עבור ה[[משתמש (מחשוב)|משתמש]] ("הפשוט") בתבנית, המתאר ומדגים דרכים שונות להשתמש בה.

הדרך המקובלת היא ליצור דף משנה בשם '''תבנית:שם התבנית/תיעוד''' ובו להסביר למה מיועדת התבנית, אופן השימוש בה, וכן הלאה.

בדף התבנית עצמו, יש להוסיף תחת תג noinclude (שכבר קיים בדרך כלל), ובו להוסיף {{תב|תיעוד}}.

כחלק מההסבר, ניתן לעשות שימוש בתגיות "<nowiki><code>" ו-"&lt;nowiki&gt;</nowiki>" (חפשו מידע בדף "[[עזרה:תחביר ויקי]]") כדי להדגים דרכים שונות להשתמש בתבנית, כפי שנעשה בדף זה. ניתן להיעזר גם בתבנית {{תב|אופן השימוש}}.

רצוי למקם

;[[חב"דפדיה:בוקמרקלטים]]
תבנית שהותאמה לשימוש בבוקמרקלטים מומלץ לעדכן בתיעוד על כך באמצעות התבנית {{תב|יש בוקמרקלט}}, וכך גם לעודד את השימוש בבוקמרקלטים.