<span class="mw-page-title-namespace">Hilfe</span><span class="mw-page-title-separator">:</span><span class="mw-page-title-main">Vorlagendokumentation</span>

Hilfe:Vorlagendokumentation

<p>Im Prinzip soll jede <a href="/de/Hilfe:Vorlagen" title="Hilfe:Vorlagen" class="wl">Vorlage</a> mit einer <a href="/de/Softwaredokumentation" title="Softwaredokumentation" class="wl">Dokumentation</a> ausgestattet werden.</p>
<ul><li>Bei trivialen, offenkundigen Fällen wie <a href="/de/Hilfe:Navigationsleisten" title="Hilfe:Navigationsleisten" class="wl">Navigationsleisten</a> mit schlüssiger Namensgebung und ohne Parameter mag die sichtbare Dokumentation einmal entfallen; zumindest eine Kategorisierung muss aber noch geleistet werden.<span class="mw-ref reference" id="cite_ref-1"><a href="#cite_note-1" style="counter-reset: mw-Ref 1;"><span class="mw-reflink-text">[1]</span></a></span></li>
<li>Bereits eine <a href="/de/Hilfe:Infoboxen" title="Hilfe:Infoboxen" class="wl">Infobox</a> muss die Interpretation bestimmter Daten erläutern, könnte aber auf eine analoge Infobox zu einem übergeordneten Thema verweisen.</li>
<li>Bei projektweit und häufig eingebundenen Vorlagen ist die Dokumentation unerlässlich.</li></ul>

<div class="noprint navigation-not-searchable" style="float: right; margin-bottom: 1em; margin-left: 0.5em; position: relative; top: -1em;" id="LinkboxHilfe" role="navigation" about="#mwt1">
<div class="hintergrundfarbe2" style="clear:right; border:1px solid #107010; margin-top:1em; max-width:15em; width:13em;" title="Navigation über alle Hilfeseiten">
<div style="background:#B9FFC5; border-bottom:solid 1px #107010; font-size:120%; padding:.5em;" class="notheme">
<b><a href="/de/Hilfe:Übersicht" title="Hilfe:Übersicht" class="wl">Hilfe</a></b><div class="floatright noviewer" aria-hidden="true" role="presentation"><span><a href="/de/Hilfe:Übersicht" title="Hilfe" class="image wl"><img loading="lazy" alt="Wiki-lifebelt.svg" src="//upload.wikimedia.org/wikipedia/commons/thumb/3/3c/Wiki-lifebelt.svg/25px-Wiki-lifebelt.svg.png" decoding="async" data-file-width="48" data-file-height="48" data-file-type="drawing" height="25" width="25" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/3/3c/Wiki-lifebelt.svg/38px-Wiki-lifebelt.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/3/3c/Wiki-lifebelt.svg/50px-Wiki-lifebelt.svg.png 2x"></a></span></div></div>
<div style="background:#E0FFD0;font-size:90%; padding:.5em;" class="notheme">
<ul><li><a href="/de/Hilfe:Navigation" title="Hilfe:Navigation" class="wl">Navigation</a></li>
<li><a href="/de/Hilfe:Benutzerkonto" title="Hilfe:Benutzerkonto" class="wl">Benutzerkonto</a></li>
<li><a href="/de/Hilfe:Bearbeiten" title="Hilfe:Bearbeiten" class="wl">Bearbeiten</a></li>
<li><a href="/de/Hilfe:Wikisyntax" title="Hilfe:Wikisyntax" class="wl">Wikisyntax</a></li>
<li><a href="/de/Hilfe:Seitenverwaltung" title="Hilfe:Seitenverwaltung" class="wl">Seitenverwaltung</a></li>
<li><a href="/de/Hilfe:Bausteine" title="Hilfe:Bausteine" class="wl">Bausteine</a>
<ul><li><a href="/de/Hilfe:Vorlagen" title="Hilfe:Vorlagen" class="wl">Vorlagen</a>
<ul><li><a href="/de/Hilfe:Seiten_einbinden" title="Hilfe:Seiten einbinden" class="wl">Seiten einbinden</a></li>
<li><a href="/de/Hilfe:Vorlagen/Programmierung" title="Hilfe:Vorlagen/Programmierung" class="wl">Vorlagen<span>­</span>programmie<span>­</span>rung</a></li>
<li><a href="/de/Hilfe:Vorlagendokumentation" title="Hilfe:Vorlagendokumentation" class="wl">Vorlagen<span>­</span>dokumentation</a></li>
<li><a href="/de/Hilfe:TemplateData" title="Hilfe:TemplateData" class="wl">TemplateData</a></li>
<li><a href="/de/Hilfe:Lua" title="Hilfe:Lua" class="wl">Lua</a></li>
<li><a href="/de/Hilfe:Vorlagenspielwiese" title="Hilfe:Vorlagenspielwiese" class="wl">Vorlagen<span>­</span>spielwiese</a></li>
<li><a href="/de/Hilfe:Vorlagenbeschränkungen" title="Hilfe:Vorlagenbeschränkungen" class="wl">Vorlagen<span>­</span>beschränkungen</a></li>
<li><a href="/de/Hilfe:Vorlagen/VisualEditor" title="Hilfe:Vorlagen/VisualEditor" class="wl">Anwendung im VisualEditor</a></li>
<li><a href="/de/Hilfe:Vorlagen/Wizard" title="Hilfe:Vorlagen/Wizard" class="wl">WikiEditor (2010)</a></li></ul></li>
<li><a href="/de/Hilfe:Eingabefelder" title="Hilfe:Eingabefelder" class="wl">Eingabefelder</a></li></ul></li>
<li><a href="/de/Hilfe:Bild_und_Ton" title="Hilfe:Bild und Ton" class="wl">Bild und Ton</a></li>
<li><a href="/de/Hilfe:Kommunikation" title="Hilfe:Kommunikation" class="wl">Kommunikation</a></li>
<li><a href="/de/Hilfe:Technik" title="Hilfe:Technik" class="wl">Technik</a></li></ul>
<hr style="margin:.5em 0;">
<ul><li><a href="/de/Hilfe:Index" title="Hilfe:Index" class="wl">Index – <span style="white-space:nowrap">Infos von A bis Z</span></a></li>
<li><a href="/de/Hilfe:Alle_Hilfeseiten" title="Hilfe:Alle Hilfeseiten" class="wl">Alle Hilfeseiten</a></li>
<li><a href="/de/Hilfe:Glossar" title="Hilfe:Glossar" class="wl">Glossar</a></li></ul>
<div class="Hinweis_Verhalten_im_Notfall center">
<hr style="margin:.5em 0;">
<div style="background-color: #FFD700; border: 1px solid #FFFF00; margin: auto; padding: 3px;" class="notheme"><a href="/de/Wikipedia:Verhalten_im_Notfall" title="Wikipedia:Verhalten im Notfall" class="wl">Verhalten im Notfall</a></div></div>
</div>
</div></div><style data-mw-deduplicate="TemplateStyles:r201149660" typeof="mw:Extension/templatestyles">.mw-parser-output ol.breadcrumb-nav-container,.mw-parser-output ul.breadcrumb-nav-container{list-style-image:none;list-style-position:outside;list-style-type:none;margin:0.2em;padding-left:0}.mw-parser-output ol.breadcrumb-nav-container>li,.mw-parser-output ul.breadcrumb-nav-container>li{display:inline;padding:0}.mw-parser-output ol.breadcrumb-nav-container>li,.mw-parser-output ol.breadcrumb-nav-gt>li::before,.mw-parser-output ol.breadcrumb-nav-lt>li::before,.mw-parser-output ul.breadcrumb-nav-container>li,.mw-parser-output ul.breadcrumb-nav-gt>li::before,.mw-parser-output ul.breadcrumb-nav-lt>li::before{margin-right:0.3em}.mw-parser-output ol.breadcrumb-nav-gt>li:nth-child(1n/**/+2)::before,.mw-parser-output ul.breadcrumb-nav-gt>li:nth-child(1n/**/+2)::before{content:"\3e "}.mw-parser-output ol.breadcrumb-nav-lt>li:nth-child(1n/**/+2)::before,.mw-parser-output ul.breadcrumb-nav-lt>li:nth-child(1n/**/+2)::before{content:"\3c "}.mw-parser-output ol.breadcrumb-nav-middot>li::after,.mw-parser-output ul.breadcrumb-nav-middot>li::after{content:"●";font-size:85%;margin-left:0.5em;vertical-align:top}.mw-parser-output ol.breadcrumb-nav-pipe>li::after,.mw-parser-output ul.breadcrumb-nav-pipe>li::after{content:"|";margin-left:0.5em}.mw-parser-output ol.breadcrumb-nav-middot>li:last-child::after,.mw-parser-output ul.breadcrumb-nav-middot>li:last-child::after,.mw-parser-output ol.breadcrumb-nav-pipe>li:last-child::after,.mw-parser-output ul.breadcrumb-nav-pipe>li:last-child::after{display:none}@media screen and (max-width:799px){.mw-parser-output .breadcrumb-nav-container.subpages{display:none}}</style><ol id="contentSub2" class="subpages noprint navigation-not-searchable breadcrumb-nav-container breadcrumb-nav-gt" style="list-style: outside none none; margin: 0 0 0.3em; padding-left: 0;" role="navigation">
<li><a href="/de/Hilfe:Übersicht" title="Hilfe:Übersicht" class="wl">Hilfe</a></li><li><a href="/de/Hilfe:Bausteine" title="Hilfe:Bausteine" class="wl">Bausteine</a></li><li><a href="/de/Hilfe:Vorlagen" title="Hilfe:Vorlagen" class="wl">Vorlagen</a></li>
<li><b>Vorlagendokumentation</b></li>
</ol>
<p>In erster Linie informiert die Vorlagendokumentation die Anwender über die korrekte Benutzung, den Zweck und das zu erwartende Ergebnis. Darüber hinaus ergeben sich aus der Dokumentation auch Hinweise für die Programmierer; zu inneren Strukturen und Testfälle zur Überprüfung der richtigen Funktion. Nebenbei wird die Vorlage auf diesem Weg auch kategorisiert; möglicherweise gibt es vereinzelt auch noch <a href="/de/Hilfe:Internationalisierung" title="Hilfe:Internationalisierung" class="wl">Interlanguages</a>.</p>



Im Prinzip soll jede Vorlage mit einer Dokumentation ausgestattet werden. In erster Linie informiert die Vorlagendokumentation die Anwender über die korrekte Benutzung, den Zweck und das zu erwartende Ergebnis. Darüber hinaus ergeben sich aus der Dokumentation auch Hinweise für die Programmierer; zu inneren Strukturen und Testfälle zur Überprüfung der richtigen Funktion. Nebenbei wird die Vorlage auf diesem Weg auch kategorisiert; möglicherweise gibt es vereinzelt auch noch Interlanguages. 