Orchestrator 플러그인 및 관련 API 설명서에 대한 UI(사용자 인터페이스) 문자열을 작성하는 경우 허용되는 스타일 및 형식 규칙을 따라야 합니다.

일반 권장 사항

  • 플러그인에 포함된 VMware 제품의 정식 이름을 사용합니다. 예를 들어 다음 제품에 대한 정식 이름 및 VMware 용어를 사용합니다.

    올바른 용어

    사용 금지

    vCenter Server

    VC 또는 vCenter

    vCloud Director

    vCloud

  • 마침표를 사용하여 모든 워크플로 설명을 종료합니다. 예를 들어 Creates a new Organization.은 워크플로 설명입니다.

  • 맞춤법 검사기가 있는 텍스트 편집기를 사용하여 설명을 작성한 다음 플러그인으로 이동합니다.

  • 플러그인 이름이 해당 플러그인과 연결되는 승인된 타사 제품 이름과 정확히 일치하는지 확인합니다.

워크플로 및 작업

  • 정보를 제공하는 설명을 작성합니다. 대부분의 작업 및 워크플로에는 한두 문장이면 충분합니다.

  • 상위 수준 워크플로는 보다 광범위한 설명 및 주석을 포함할 수 있습니다.

  • 동사로 설명을 시작합니다(예: Creates…). 자체 참조 언어(예: This workflow creates)를 사용하지 마십시오.

  • 문장을 완성하는 설명 끝에 마침표를 넣습니다.

  • 워크플로 또는 작업의 구현 방법 대신 해당 기능을 설명합니다.

  • 워크플로 또는 작업은 일반적으로 폴더 및 패키지에 포함됩니다. 이러한 폴더 및 패키지에 대한 간단한 설명도 포함합니다. 예를 들어 워크플로 폴더에 대해 Set of workflows related to vApp Template management와 유사한 설명을 작성할 수 있습니다.

워크플로 및 작업 매개 변수

  • 설명이 포함된 명사 구(예: Name of)로 워크플로 및 작업 설명을 시작합니다. It's the name of와 같은 구를 사용하지 마십시오.

  • 매개 변수 및 작업 설명의 끝에 마침표를 넣지 마십시오. 이러한 설명은 완성된 문장이 아닙니다.

  • 워크플로의 입력 매개 변수는 프레젠테이션 보기에서 적절한 이름으로 레이블을 지정해야 합니다. 대부분의 경우 관련 입력을 표시 그룹으로 결합할 수 있습니다. 예를 들어 Name of the Organization과 Full name of the Organization이라는 레이블을 지닌 두 개의 입력을 사용하는 대신, Organization이라는 레이블의 표시 그룹을 만들고 Organization 그룹에 Name 및 Full name 입력을 배치할 수 있습니다.

  • 단계 및 표시 그룹의 경우 워크플로 프레젠테이션에 표시되는 설명이나 주석도 추가합니다.

플러그인 API

  • API 설명서는 vso.xml 파일 및 Java 소스 파일에 있는 모든 설명서를 참조합니다.

  • vso.xml 파일의 경우 워크플로 및 작업에 사용하는 해당 메서드와 함께 찾기 개체와 스크립팅 개체의 설명에 동일한 규칙을 사용합니다. 개체 특성 및 메서드 매개 변수의 설명에 워크플로 및 작업 매개 변수와 동일한 규칙을 사용합니다.

  • vso.xml 파일에서는 특수 문자를 피하고 <![CDATA[insert your description here!]]> 태그 내에 설명을 포함합니다.

  • Java 소스 파일에 표준 Javadoc 스타일을 사용합니다.