Hallo zusammen,
momentan arbeite ich an einem relativ umfangreichen Plugin. Es wird viele Parameter, Befehle und natürlich auch Informationen im Hilfetext dazu haben. Die Parameter werden dort noch ausführlich erklärt, da Infos zu ihnen meist recht umfangreich sind und mehr Platz als die zwei Zeilen benötigen. Irgendwann steht man dann vor dem Problem die ganzen Informationen übersichtlich zu gestallten. Daher würde ich gerne von euch wissen ob ihr damit Erfahrung habt und welche Möglichkeiten ihr bevorzugt. Mir fallen da spontan nur zwei sinnige Möglichkeiten ein.
Möglichkeit 1: Die Infos zu den Befehlen und Parametern werden getrennt aufgelistet. Beispielweise werden erst alle Befehle mit den jeweiligen Erklärungen aufgelistet und danach kommt der Block mit zusätzlichen Parameterinfos.
Möglichkeit 2: Die Infos zu den Befehlen und Parametern werden nach Anwendungsbereichen sortiert und zum Teil zusammen aufgelistet. Wenn also ein Befehl auf irgendwelche Parameter Bezug nimmt, stehen die Parameterinfos gleich dabei.
Beide Möglichkeiten haben Vor- und Nachteile. Wie würdet ihr das handhaben? Gibt es eurer Meinung nach noch andere, sinnige Möglichkeiten?
Bin gespannt auf eure Antworten