Wenn Sie Benutzeroberflächen-Zeichenfolgen für Orchestrator-Plug-Ins und die zugehörige API-Dokumentation schreiben, folgen Sie den allgemein anerkannten Stil- und Formatregeln.

Allgemeine Empfehlungen

  • Verwenden Sie die offiziellen Namen für VMware-Produkte, die im Plug-In involviert sind. Verwenden Sie beispielsweise offizielle Namen für die folgenden Produkte sowie VMware-Terminologie.

    Korrekter Begriff

    Nicht verwenden

    vCenter Server

    VC oder vCenter

    vCloud Director

    vCloud

  • Beenden Sie alle Workflowbeschreibungen mit einem Punkt. Beispielsweise ist Creates a new Organization. eine Workflowbeschreibung.

  • Verwenden Sie einen Texteditor mit einer Rechtschreibprüfung, um die Beschreibungen zu schreiben, und verschieben Sie sie dann in das Plug-In.

  • Achten Sie darauf, dass der Name des Plug-Ins genau mit dem genehmigten Produktnamen des Drittanbieters, mit dem es verknüpft ist, übereinstimmt.

Workflows und Aktionen

  • Verfassen Sie informative Beschreibungen. Ein oder zwei Sätze genügen für die meisten Aktionen und Workflows.

  • Hochrangige Workflows beinhalten möglicherweise umfangreichere Beschreibungen und Kommentare.

  • Beginnen Sie Beschreibungen mit einem Verb, z. B. Creates…. Verwenden Sie keine auf sich selbst verweisende Sprache wie beispielsweise This workflow creates.

  • Setzen Sie einen Punkt am Ende der Beschreibungen, die einen ganzen Satz darstellen.

  • Beschreiben Sie, was ein Workflow oder eine Aktion macht, anstatt wie er/sie implementiert wird.

  • Workflows und Aktionen sind normalerweise in Ordnern und Paketen enthalten. Beschreiben Sie auch diese Ordner und Pakete kurz. Beispielsweise kann ein Workflowordner eine Beschreibung wie die folgende haben: Set of workflows related to vApp Template management.

Parameter von Workflows und Aktionen

  • Beginnen Sie Beschreibungen für Workflows und Aktionen mit einer beschreibenden Nominalphrase, z. B. Name of Verwenden Sie keine Phrasen wie It's the name of.

  • Setzen Sie keinen Punkt am Ende von Beschreibungen für Parameter und Aktionen. Es sind keine vollständigen Sätze.

  • Eingabeparameter von Workflows müssen eine Bezeichnung mit entsprechenden Namen in der Präsentationsansicht angeben. In vielen Fällen können Sie verwandte Eingaben in einer Anzeigegruppe zusammenfassen. Anstatt zwei Eingaben mit den Bezeichnungen „Name der Organisation“ und „Vollständiger Name der Organisation“ zu erstellen, können Sie beispielsweise eine Anzeigegruppe mit der Bezeichnung „Organisation“ erstellen und die Eingaben „Name“ und „Vollständiger Name“ in die Gruppe „Organisation“ platzieren.

  • Fügen Sie für Schritte und Anzeigegruppen Beschreibungen oder Kommentare hinzu, die auch in der Workflowpräsentation angezeigt werden.

Plug-In-API

  • Die Dokumentation der API verweist auf die gesamte Dokumentation in der Datei vso.xml und in den Java-Quelldateien.

  • Verwenden Sie für die Datei vso.xml dieselben Regeln für die Beschreibungen der Finder-Objekte und Skripterstellungs-Objekte mit ihren Methoden, die Sie für Workflows und Aktionen verwenden. Beschreibungen von Objektattributen und Methodenparametern verwenden dieselben Regeln wie die Workflow- und Aktionsparameter.

  • Vermeiden Sie Sonderzeichen in der Datei vso.xml und beziehen Sie die Beschreibungen innerhalb eines <![CDATA[insert your description here!]]>-Tags mit ein.

  • Verwenden Sie den Javadoc-Standardstil für die Java-Quelldateien.