עריכת הדף "איך ליצור תבנית" (פסקה)

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

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

את ההסבר לאופן השימוש בתבנית ניתן להכניס בדף התבנית עצמו, כאשר דואגים כי כל התוכן '''לא''' יופיע בדפים שבהם ישלבו את התבנית (ראו סעיף "[[עזרה:תבניות#תכנים שיופיעו בדף התבנית בלבד|תכנים שיופיעו בדף התבנית בלבד]]"). רצוי לא לרשום את ההסבר בדף השיחה של התבנית. פרקטיקה מקובלת נוספת היא לרשום את ההסבר ב[[עזרה:דף משנה|דף משנה]] לדף התבנית ולשלב את תוכנו בדף התבנית על ידי שילוב דף המשנה:
:{{קוד|{{מימין לשמאל|<nowiki><noinclude>{{תבנית:שם התבנית/שם דף המשנה}}<‎/noinclude></nowiki>}}}}

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

אפשרות נוספת היא לעשות שימוש בתבניות {{תב|תיעוד}} או {{תב|תיעוד תבנית}}, הדורשות רישום התיעוד בדף משנה ששמו "תיעוד".

'''המלצה:''' פרקטיקה מקובלת היא לכתוב את התיעוד והוראות השימוש אחרי הקוד הטכני של התבנית עצמה.

=== אשף התבניות ===
{{הפניה לערך מורחב|עזרה:אשף התבניות}}
כדי להקל על המשתמשים בשימוש בתבנית, מומלץ להתאימה לשימוש ב"אשף התבניות".