Cuando escriba cadenas de la interfaz de usuario (IU) para complementos de Orchestrator y la documentación de las API relacionadas, siga las reglas de estilo y formato aceptadas.

Recomendaciones generales

  • Utilice los nombres oficiales de los productos de VMware que forman parte del complemento. Por ejemplo, utilice los nombres oficiales de los productos siguientes y la terminología de VMware.

    Término correcto

    No utilizar

    vCenter Server

    VC o vCenter

    vCloud Director

    vCloud

  • Termine todas las descripciones de flujos de trabajo con un punto. Por ejemplo, Creates a new Organization. es una descripción de flujo de trabajo.

  • Utilice un editor de texto con un corrector ortográfico para escribir las descripciones y luego páselas al complemento.

  • Asegúrese de que el nombre del complemento coincida exactamente con el nombre de producto de terceros aprobado con el que esté asociado.

Flujos de trabajo y acciones

  • Escriba descripciones informativas. Una o dos frases son suficientes para la mayoría de las acciones y los flujos de trabajo.

  • Los flujos de trabajo de nivel superior podrían incluir descripciones y comentarios más extensos.

  • Inicie las descripciones con un verbo, por ejemplo, Creates…. No utilice lenguaje que se haga referencia a sí mismo, como This workflow creates.

  • Coloque un punto al final de las descripciones que sean frases completas.

  • Describa lo que hacen un flujo de trabajo o una acción en lugar de cómo se implementan.

  • Los flujos de trabajo y las acciones se suelen incluir en carpetas y paquetes. Incluya también una breve descripción de estas carpetas y paquetes. Por ejemplo, una carpeta de flujo de trabajo puede tener una descripción similar a Set of workflows related to vApp Template management.

Parámetros de flujos de trabajo y acciones

  • Inicie las descripciones de flujos de trabajo y acciones con un sintagma nominal descriptivo, por ejemplo Name of. No utilice frases del tipo It's the name of.

  • No coloque punto al final de las descripciones de parámetros y acciones. No son frases completas.

  • Los parámetros de entrada de los flujos de trabajo deben especificar una etiqueta con nombres apropiados en la vista de presentación. En muchos casos, puede combinar entradas relacionadas en un grupo de visualización. Por ejemplo, en lugar de tener dos entradas con las etiquetas Nombre de empresa y Nombre completo de la empresa, puede crear un grupo de visualización con la etiqueta Empresa y colocar las entradas Nombre y Nombre completo en el grupo Empresa.

  • Para los pasos y los grupos de visualización, añada descripciones o comentarios que también aparezcan en la presentación del flujo de trabajo.

API de complemento

  • La documentación de la API hace referencia a toda la documentación del archivo vso.xml y los archivos de origen de Java.

  • Para el archivo vso.xml, utilice las mismas reglas para las descripciones de los objetos de buscador y de creación de scripts con sus métodos que las que utiliza para los flujos de trabajo y las acciones. Las descripciones de los atributos de objetos y los parámetros de método utilizan las mismas reglas que los parámetros de flujos de trabajo y las acciones.

  • Evite los caracteres especiales en el archivo vso.xml e incluya las descripciones dentro de una etiqueta <![CDATA[insert your description here!]]>.

  • Utilice el estilo de Javadoc estándar para los archivos de origen de Java.