Vorlage Diskussion:tvOSinfo

Unzufrieden

Ich bin mit dieser Vorlage, und analog mit ihrem Pendant Vorlage:iOS, massiv unzufrieden.

• Namensgebung
  • Vorlagen sollen ihre Funktion verständlich im Namen ausdrücken.
  • Außerdem verwenden wir keine drei- oder vier-Buchstaben-Namen mehr, wenn es sich nicht um Angelegenheiten von projektweiter Bedeutung handelt, die jedem Autor sofort einleuchtet.
  • Die Funktion hier wäre zutreffender mit tvOS-Version angegeben.
  • Unter dem Namen tvOS, wenn man sich schon so kurz ausdrücken würde, könnte genauso ein Link auf die Software-Dokumentation oder eine sonstige Website verborgen sein. Der Name ist also nicht hinreichend selbsterklärend.
• Eine längere Dokumentation lagern wir immer auf eine /Doku-Unterseite aus, erst recht wenn TemplateData beteiligt ist; wenn es aber wie ja hier vorliegend eine /Doku-Unterseite gibt, dann steht auf der Programmierungsseite nichts anderes mehr als die wirksame Programmierung und {{Dokumentation}}.
• Unsere wirksame Vorlagenprogrammierung beginnt mit <onlyinclude> und endet mit </onlyinclude>.
• Mittels TemplateData wird für Anwender des VisualEditor, des Quelltexteditors „2017“ und dem Vorlagenmeister die Beschreibung angezeigt. Hier wurde jedoch die Funktionsbeschreibung weggelassen, damit wird der Zweck verborgen.
• TemplateData wurde auch nur weiter hinten unter der Hauptüberschrift „Parameter“ angeordnet; das lässt bereits auf ein grundsätzliches Missverständnis der TemplateData-Funktionalität schließen, das hier offenbar nur als eine Art Tabellenformat für Parameterlisten angesehen wurde.
• Die Parametervorgaben enthalten einen Denkfehler und Konflikt; der einzige Parameter wird als „erforderlich“ verlangt, es wird aber ein gültiger Standardwert zugelassen, wenn kein Pflichtparameterwert angegeben ist. Das geht nicht gleichzeitig. Dass ungültige Angaben irgendwelche Fehlermeldungen und Hinweise nach sich ziehen würden, ist nicht für Anwender der Vorlage zu dokumentieren und für die Anwendung gegenstandslos und eine Fehlermeldung ist auch kein gültiger Standardwert.
• Die Angaben für „Beispiel“ sind kein Anwendungsbeispiel; das heißt nicht »Version«, was ein Anwender eintippen solle, sondern 1.23.456c.
• Dass der Parameter eine Versionsnummer oder ein Datum (in welchem Format? TT.Mon.JJJJ oder JJJJ-MM-TT oder was?) enthalten solle, ist Teil der Parameterbeschreibung und nicht das Anwendungsbeispiel.

Ich bitte die Gesamtgestaltung nunmehr zu überarbeiten:

1. Verschiebung auf einen selbsterklärenden Namen, etwa tvOS-Version – die sehr wenigen Verwendungen werden sich leicht anpassen lassen, so dass auch kein Verschieberest zurückbleiben muss.
2. Korrekte und zeitgemäße Dokumentation; siehe etwa die grad kürzlich von mir angelegte Vorlage:Zeitstempel.
3. Auflösung des Widerspruchs der Parameteranforderung.

VG --PerfektesChaos 16:31, 20. Sep. 2018 (CEST)