Skip to main content
Contributor's Guide
본 한국어 번역은 사용자 편의를 위해 제공되는 기계 번역입니다. 영어 버전과 한국어 버전이 서로 어긋나는 경우에는 언제나 영어 버전이 우선합니다.

NetApp 문서의 스타일 가이드

기여자
PDF

우리의 스타일은 대화적이고 공감적이지만, 우리는 전문가답게 대화를 나누며 요점을 얻습니다. NetApp 문서의 콘텐츠를 작성할 때 다음 지침을 따르십시오.

대화식으로 쓰기

전문 동료에게 설명할 때 말하는 것처럼 씁니다. 대화 어조로 글을 작성하면 청중과 소통할 수 있습니다.

너무 격식적인 너무 캐주얼합니다 우리의 스타일

BlueXP 계층화에 문제가 발생한 경우 클러스터 대시보드에서 상태를 확인하고 오류가 발생한 이유를 확인할 수 있습니다. 상태는 ONTAP 시스템 및 서비스 커넥터 상태를 반영합니다.

실패가 발생할 때는 재미가 없습니다. 그렇지만 클러스터 대시보드 를 확인하여 발생한 것과 영향을 받는 것을 알면 되므로 걱정하실 필요가 없습니다.

장애가 발생하면 BlueXP 계층화는 클러스터 대시보드에 "실패" 상태가 표시됩니다. 상태를 보고 실패에 대한 정보를 봅니다.

스토리지를 프로비저닝하려면 먼저 BlueXP에서 ONTAP 클러스터를 검색해야 합니다. 검색이 완료되면 작업 환경을 열어 스토리지를 프로비저닝해야 합니다.

먼저 BlueXP에서 ONTAP 클러스터를 검색한 다음 작업 환경을 열어 스토리지 프로비저닝을 시작하기만 하면 됩니다. 간단합니다!

BlueXP에서 ONTAP 클러스터를 검색한 후 작업 환경을 열어 스토리지를 프로비저닝합니다.

설정 마법사가 시작되면 마법사의 지시에 따라 노드를 설정하고 클러스터에 연결합니다. 다음 단계에서는 마법사의 단계를 안내합니다.

설치 마법사가 나타나(거의 마법과 유사) 노드를 설정하고 클러스터에 결합하는 간단한 프로세스를 안내합니다.

설치 마법사의 지침에 따라 노드를 설정하고 클러스터에 연결합니다.

여러 콘텐츠 형식 유형 중에서 선택하여 새 시스템을 설치하고 설정할 수 있습니다. 각 형식 유형은 전체 지침을 제공합니다. 원하는 학습 방법과 가장 일치하는 형식 유형을 선택합니다.

시스템을 어떻게 설정 및 설치하시겠습니까? 여러 콘텐츠 형식 유형의 지침을 제공하지만 원하는 학습 방법은 알고 있는 경우에만 제공됩니다.

시스템 설치 및 설정 과정을 안내하는 콘텐츠 형식 유형을 선택하십시오.

수축 사용

수축은 A를 강화합니다 대화 톤, 그리고 많은 수축은 쉽게 이해하고 번역할 수 있다 .

자세한 내용을 보려면 확장하십시오

  • 쉽게 이해하고 번역할 수 있는 다음과 같은 수축을 사용합니다.

    그렇지 않습니다

    모두 가능합니다

    그렇지 않습니다

    우리는

    그렇지 않았습니다

    바로 그것입니다

    그렇지 않았습니다

    자, 그럼

    그렇지 않았습니다

    (미래 시제가 필요한 경우)

    그렇지 않습니다

    안 함(향후 시제가 필요한 경우)

    하지 마십시오

    (향후 시제가 필요한 경우)

  • 이해 및 번역이 어려운 다음과 같은 금기사항은 사용하지 마십시오.

    그럴 겁니다

    그래야 합니다

    그렇지 않을 것입니다

    그래서는 안 되죠

    할 수 있습니다

    할 수 없습니다

간단한 쓰기

크고 혼란스러운 단어는 피하십시오. 단순성 유지 당신은 전문 동료에게 무언가를 설명하고 있으며, 자신의 어휘를 드러내지 않습니다.

이 대신 : "NetApp Cloud Central 계정에서 사용자를 연결 해제합니다."

이 작업을 수행하십시오.: "NetApp Cloud Central 계정에서 사용자를 제거합니다."

최소한의 글쓰기

짧고 단순한 문장으로 콘텐츠를 읽기 쉽게 만들거나 스캔할 수 있습니다. 한 번에 더 긴 문장을 사용해도 되지만 더 짧은 문장을 사용하면 됩니다. 이렇게.

이 대신 : "AWS의 Cloud Volumes ONTAP 시스템과 다른 네트워크의 ONTAP 시스템 간에 데이터를 복제하려면 Amazon VPC와 다른 네트워크(예: Azure VNet 또는 회사 네트워크) 간에 VPN 연결이 필요합니다."

이 작업을 수행하십시오: "네트워크 간 데이터 복제에는 VPN을 통한 연결이 필요합니다. 예를 들어, Amazon VPC와 기업 네트워크 간 또는 AWS와 Azure 간에 연결할 수 있습니다."

스스로에게 다음 사항을 물어보십시오.

  • 현재 사용자가 이 위치에서 이 콘텐츠를 필요로 합니까?

  • 사용자 인터페이스가 이미 사용자를 충분히 안내하고 있습니까? 그렇지 않은 경우 간결하게 추가할 수 있는 추가 지침은 무엇입니까?

  • 너무 공식적이거나 지나치게 캐주얼한 것 없이 컨텐츠를 더 적은 단어로 표현할 수 있습니까?

  • 긴 문장을 줄이거나 단순화하거나 두 개 이상의 문장으로 나눌 수 있습니까?

  • 목록을 사용하여 콘텐츠를 보다 스캔 가능하게 만들 수 있습니까?

  • 그래픽을 사용하여 텍스트 블록을 보강하거나 바꿀 수 있습니까?

쓰기 활성

수동적인 음성을 피하는 것은 기술 문서 작성을 위한 표준 규칙이지만 대화를 나누고 싶을 때 액티브 음성을 사용하는 것이 특히 중요합니다.

활성 음성

문장의 주체가 동사의 동작을 수행하도록 적극적인 음성을 사용합니다. 이것은 일반적으로 동사가 문장의 제목 뒤에 있음을 의미합니다. 활성 음성이 또렷하고 또렷하게 메시지를 전달합니다. 수동적인 음성을 사용해야 하는 특별한 이유가 없는 한 활성 음성을 사용하고 사용자를 "사용자"로 직접 처리합니다.

다음은 효과적인 음성 쓰기의 몇 가지 예입니다. 다음과 같이 작성:

  • 첫 번째 클러스터를 구축하기 전에 필요한 권한을 제공합니다.

  • 시스템을 부적절하게 종료하면 인터페이스에 경고 메시지가 표시됩니다.

  • NetApp이 계약을 수주했습니다.

수동적인 음성

수동적 음성에 있어, 그 조치의 실행자가 불분명하다:

  • 시스템이 부적절하게 종료될 경우 경고 메시지가 표시됩니다.

  • NetApp이 계약을 체결했습니다.

다음과 같은 경우 수동 음성 사용:

  • 누가 또는 무엇을 수행했는지 알 수 없습니다.

  • 당신은 작업 결과에 대해 사용자 책임을 회피하려고 합니다.

  • 필수 구성 요소 정보 등과 같은 내용을 기록할 수 없습니다.

필수적 분위기

사용자 작업 목록의 단계, 지침, 요청 및 제목에 명령적 분위기를 사용합니다.

  • 작업 환경 페이지에서 검색 을 클릭하고 ONTAP 클러스터 를 선택합니다.

  • "캠 핸들을 돌려 전원 공급 장치와 수평이 되도록 합니다."

수동 음성을 대체하기 위해 명령적 음성 사용을 고려하십시오.

이 대신: "첫 번째 클러스터를 배포하기 전에 필요한 권한을 제공해야 합니다."

이 작업을 수행하십시오.: "첫 번째 클러스터를 배포하기 전에 필요한 권한을 제공하십시오."

필수 음성을 사용하여 개념 및 참조 정보에 단계를 포함시키지 마십시오.

추가 동사 규칙은 다음을 참조하십시오.

일관성 있는 내용을 작성합니다

"전문 동료에게 설명할 때 말하는 것처럼 쓰기"는 모든 사람에게 다른 것을 의미합니다. 전문적이면서도 대화 스타일은 사용자와 연결할 수 있도록 도와주며, 여러 저작자 간에 사소한 불일치가 발생하는 빈도를 증가시킵니다.

  • 콘텐츠를 명확하고 쉽게 만드는 데 집중합니다. 모든 콘텐츠가 명확하고 사용하기 쉽다면 사소한 불일치는 중요하지 않습니다.

  • 작성 중인 페이지 내에서 일관성을 유지합니다.

  • 항상 의 지침을 따르십시오 글로벌 고객을 위한 글을 작성합니다.

포용적인 언어를 사용합니다

NetApp은 제품 설명서에 차별적이고 독점적인 언어가 포함되어 있지 않아야 한다고 생각합니다. 우리가 사용하는 말은 고객과 긍정적인 관계를 형성하거나 고객을 소외시키는 데 차이가 있습니다. 특히 문구에서는 영향력이 의도보다 더 중요합니다.

NetApp 제품의 콘텐츠를 만들 때 성능 저하, 인종주의, 현증 또는 기타 강압으로 해석될 수 있는 언어는 피해야 합니다. 대신, 문서를 사용해야 하는 모든 사람이 액세스할 수 있고 환영하는 언어를 사용하십시오. 예를 들어, "마스터/슬레이브" 대신 "기본/보조"를 사용합니다.

사람을 가장 먼저 참조한 후 장애를 나타내는 사람 우선 언어를 사용합니다.

그는, 그는, 그의, 그녀, 그녀의, 또는 일반 참조의 her를 입력합니다. 대신:

  • 두 번째 사람을 사용하려면 문장을 다시 작성합니다.

  • 복수명사와 대명사를 갖도록 문장을 다시 작성합니다.

  • 대명사 대신 "the" 또는 "a"를 사용합니다(예: "the document").

  • 개인의 역할(예: 독자, 직원, 고객 또는 클라이언트)을 참조합니다.

  • "사람" 또는 "개인"이라는 용어를 사용합니다.

  • 포함 또는 배타적으로 간주되는 단어와 구문의 예 *

포용적인 예 특별한 사례

운영/2차

마스터/슬레이브

허용 목록

화이트리스트

차단 목록

블랙리스트

중지

죽이세요

응답을 중지합니다

꽉 잡아

종료 또는 취소

중단

시간

맨아워

개발자는 개발 환경에서 서버에 액세스해야 하지만 Azure의 서버에 액세스할 필요는 없습니다.

개발자는 개발 환경의 서버에 액세스해야 하지만 Azure의 서버에 액세스할 필요는 없습니다.

맹인 사람

시각 장애

시력이 약한 사람

시력 장애

요점을 확인합니다

각 페이지는 사용자에게 가장 중요한 것부터 시작해야 합니다. 우리는 사용자가 무엇을 하려고 하는지 알아내고 그 목표를 달성하도록 돕는 데 집중해야 합니다. 또한 검색 기능을 개선하기 위해 문장의 시작 부분에 키워드를 추가해야 합니다.

다음 일반 문장 지침을 따르십시오.

  • 정확하게.

  • 단어 채우기를 피합니다.

  • 짧아야 합니다.

  • 서식이 지정된 텍스트 또는 글머리 기호 목록을 사용하여 요점을 강조합니다.

  • 요점에 도달의 예 *

좋은 예 잘못된 예

비즈니스에 엄격한 보안 정책이 있는 경우 전송 중인 데이터 암호화를 사용하여 다른 네트워크에 있는 NFS 서버 간에 데이터를 동기화합니다.

Cloud Sync는 전송 중인 데이터 암호화를 사용하여 NFS 서버 간에 데이터를 동기화할 수 있습니다. 네트워크를 통한 데이터 전송에 대한 엄격한 보안 정책이 있는 경우 데이터 암호화가 도움이 될 수 있습니다.

자주 사용하는 스타일, 서식 및 페이지 레이아웃을 포함하는 문서 서식 파일을 만들어 시간을 절약할 수 있습니다. 그런 다음 새 문서를 만들 때마다 서식 파일을 사용합니다.

서식 파일을 사용하면 새 문서를 만들 수 있습니다. 서식 파일에는 자주 사용하는 스타일, 서식 및 페이지 레이아웃이 포함될 수 있습니다. 문서에 동일한 페이지 레이아웃 및 스타일을 자주 사용하는 경우 서식 파일을 만드는 것이 좋습니다.

Astra Control은 사용자에게 할당할 수 있는 3가지 운영 모드를 제공하여 Astra Control과 클라우드 환경 간의 액세스를 신중하게 제어할 수 있습니다.

Astra Control을 사용하면 AWS 계정 사용자에게 3가지 운영 모드 중 하나를 할당할 수 있습니다. 이 모드를 사용하면 IT 정책에 따라 Astra Control과 클라우드 자산 간 액세스를 신중하게 제어할 수 있습니다.

많은 시각 자료를 사용합니다

대부분의 사람들은 시각적 학습자를 나타냅니다. 비디오, 다이어그램 및 스크린샷을 사용하여 학습 효과를 높이고, 텍스트 블록을 분할하고, 작업 지침에서 사용자가 어디에 있는지 시각적으로 확인할 수 있습니다.

  • "다음 그림은 후면 패널의 AC 전원 공급 장치 LED"를 보여 주는 이미지를 설명하는 문장을 포함합니다.

  • 그림의 위치를 "다음" 또는 "앞", "위" 또는 "아래"가 아닌 것으로 참조하십시오.

  • 포함된 비주얼에 대체 텍스트를 사용합니다.

  • 시각 자료가 단계와 관련된 경우, 단계 바로 뒤에 시각을 포함하고 단계 번호와 정렬되도록 들여쓰기합니다.

스크린샷 모범 사례:

  • 작업당 5개 이하의 스크린샷을 포함해서는 안 됩니다.

  • 스크린샷에 텍스트를 포함하지 마십시오. 대신 번호가 매겨진 설명선을 사용합니다.

  • 포함하기로 선택한 스크린샷을 신중하게 선택하십시오. 스크린샷은 빠르게 업데이트되지 않을 수 있습니다.

비디오 또는 애니메이션에 대한 모범 사례:

  • 비디오 길이는 5분 미만이어야 합니다.

예

스캔 가능한 콘텐츠를 만듭니다

섹션 제목 아래의 텍스트를 구성하고 목록 및 표를 사용하여 독자가 콘텐츠를 빠르게 찾을 수 있도록 도와줍니다. 제목, 문장 및 단락은 짧고 읽기 쉬워야 합니다. 가장 중요한 정보를 먼저 제공해야 합니다.

예

사용자가 목표를 달성하는 데 도움이 되는 워크플로를 만듭니다

사용자는 콘텐츠를 읽고 특정 목표를 달성합니다. 사용자는 필요한 콘텐츠를 찾고, 목표를 달성하고, 가족 단위로 이동하기를 원합니다. 제품 또는 기능을 문서화하는 것이 우리의 임무가 아닙니다. 우리의 임무는 사용자 목표를 문서화하는 것입니다. 워크플로는 사용자가 목표를 달성하는 데 가장 직접적인 방법입니다.

워크플로는 사용자 목표를 달성하는 방법을 설명하는 일련의 단계 또는 하위 작업입니다. 워크플로의 범위는 완전한 목표입니다.

예를 들어, 볼륨을 생성하는 단계는 완전한 목표가 아니므로 워크플로가 아닙니다. ESX Server에서 스토리지를 사용할 수 있도록 하는 단계는 워크플로우일 수 있습니다. 이 단계에는 볼륨 만들기는 물론 볼륨 내보내기, 필요한 사용 권한 설정, 네트워크 인터페이스 만들기 등이 포함됩니다.

워크플로우가 고객 사용 사례에서 파생됩니다. 워크플로는 목표 달성을 위한 최상의 방법을 하나만 표시합니다.

사용자의 목표에 따라 콘텐츠를 구성합니다

사용자가 달성하려는 목표에 따라 콘텐츠를 구성하여 사용자가 정보를 빠르게 찾을 수 있도록 도와줍니다. 이 표준은 문서 사이트의 목차(탐색)와 사이트에 나타나는 개별 페이지에 적용됩니다.

다음과 같이 콘텐츠를 구성합니다.

좌측 내비게이션의 첫 번째 항목(고급)

사용자가 달성하고자 하는 목표를 중심으로 콘텐츠를 구성합니다. 예를 들어 사이트 탐색의 첫 번째 항목은 "시작" 또는 "데이터 보호"일 수 있습니다.

설명서 사이트 탐색의 두 번째 수준 항목(중간 수준)

목표를 구성하는 광범위한 작업을 중심으로 콘텐츠를 구성합니다.

예를 들어, "시작" 섹션에 다음 페이지가 포함될 수 있습니다.

  • 설치 준비

  • <product name>를 설치하고 설정합니다

  • 라이센스를 설정합니다

  • 다음에 할 수 있는 일

개별 페이지(상세 수준)

각 페이지에서 광범위한 작업을 구성하는 개별 작업에 대한 콘텐츠를 구성합니다. 예를 들어, 사용자가 설치를 준비하거나 재해 복구를 설정해야 하는 콘텐츠가 있습니다.

한 페이지에서 단일 작업 또는 여러 작업을 설명할 수 있습니다. 작업이 여러 개인 경우 페이지의 개별 섹션에 설명되어 있습니다. 각 섹션은 단일 학습 또는 광범위한 작업의 수행 측면에 중점을 두어야 합니다. 여기에는 작업을 완료하는 데 필요한 몇 가지 개념 및 참조 기반 정보가 포함될 수 있습니다.

글로벌 고객을 위한 글을 작성합니다

본사의 문서는 영어가 아닌 많은 사용자들이 읽었습니다. 우리는 신경 기계 번역 도구 또는 인간 번역을 사용하여 우리의 콘텐츠를 다른 언어로 번역합니다. 전 세계 고객을 지원하기 위해 읽기 쉽고 번역하기 쉬운 콘텐츠를 작성합니다.

전 세계 고객을 위해 다음 지침을 따르십시오.

  • 짧고 간단한 문장을 쓰십시오.

  • 표준 문법 및 구두점 사용

  • 한 단어에는 한 단어를 사용하고 한 단어에는 한 단어를 사용합니다.

  • 일반적인 자궁 수축 사용.

  • 그래픽을 사용하여 텍스트를 명확하게 표시하거나 바꿉니다.

  • 그래픽에 텍스트를 포함하지 않도록 합니다.

  • 문자열에 3개 이상의 명사를 사용하지 마십시오.

  • 명확하지 않은 선행 기술을 피합니다.

  • 전문 용어, 구어적 표현 및 은유를 피하십시오.

  • 비기술적 예는 피하십시오.

  • 하드 리턴과 간격을 사용하지 마십시오.

  • 유머나 아이러니를 사용하지 마십시오.

  • 차별적인 콘텐츠를 사용하지 마십시오.

  • 특정 페르소나를 위해 글을 쓰는 경우가 아니라면 성적으로 편향된 언어를 사용하지 마십시오.

A-Z 지침

능동형 음성(수동형 음성 대비)

을 참조하십시오 쓰기 활성.

주의

다음 레이블을 사용하여 기본 콘텐츠 흐름과 별도로 콘텐츠를 식별합니다.

  • 참고

    나머지 텍스트와 구분되어야 하는 중요한 정보는 참고를 사용하십시오. 사용자가 작업에 대해 배우거나 작업을 완료하는 데 필요하지 않은 "유용한 정보" 정보는 참고를 사용하지 마십시오.

  • 팁

    항상 모범 사례 정보를 기본적으로 문서화하는 것이 당사의 정책이므로 팁을 가급적 사용하지 마십시오. 필요한 경우 팁을 사용하여 사용자가 제품을 사용하거나 단계 또는 작업을 쉽고 효율적으로 완료할 수 있도록 도와주는 모범 사례 정보를 포함합니다.

  • 주의

    사용자에게 치명적이거나 극히 위험한 신체 상해가 발생할 수 있는 조건이나 절차에 대해 경고하려면 주의를 기울이십시오.

이후(대 "한 번")

  • "컴퓨터를 연결한 후 컴퓨터를 켜십시오"라는 내용의 연대표를 나타내려면 "이후"를 사용하십시오.

  • "1회"를 사용하여 "1회"를 의미합니다.

또한

  • "추가"를 의미하려면 "또한"를 사용하십시오.

  • "다른 방법"을 의미하는 "또한"를 사용하지 마십시오.

및/또는

더 정확한 용어가 있으면 선택합니다. 두 용어가 다른 용어보다 정확하지 않으면 "AND/OR"를 사용합니다.

현재

"이유"를 의미하는 "다른 이름으로"를 사용하지 마십시오.

사용(사용" 또는 "사용")

  • 사용 중인 엔티티가 "구성 요소 메뉴를 사용하여 리포지토리에 새 구성 요소를 추가할 수 있습니다."라는 제목인 경우 "사용"을 사용합니다.

  • "using" 또는 "with"로 문장을 시작할 수 있습니다. "SnapDrive를 사용하면 Windows 환경에서 가상 디스크 및 스냅샷 복사본을 관리할 수 있습니다."라는 제품 이름으로도 사용할 수 있습니다.

CAN("할 수 있음", "할 수 있음", "해야 함" 또는 "필수")

  • "CAN"을 사용하여 "이 절차 중에 언제든지 변경 사항을 커밋할 수 있습니다."라는 기능을 표시합니다.

  • "may"를 사용하여 "여러 프로그램을 다운로드하면 처리 시간에 영향을 줄 수 있습니다."

  • 기능이나 권한을 의미할 수 있으므로 모호한 "may"를 사용하지 마십시오.

  • "해야 함"을 사용하여 권장되지만 선택적 조치를 나타냅니다. 대신 "권장 사항"과 같은 대체 구문을 사용하는 것이 좋습니다.

  • "필수"를 사용하지 마십시오 패시브. 명령적 음성을 사용하여 생각을 지침으로 다시 언급하십시오. "MUST"를 사용하는 경우 필수 작업 또는 조건을 나타내는 데 사용합니다.

대문자 표시

거의 모든 항목에 문장 스타일의 대문자 표시(소문자)를 사용합니다. 자본만:

  • 표 제목을 포함한 문장과 제목의 첫 번째 단어입니다

  • 문장 조각을 포함한 목록 항목의 첫 번째 단어

  • 적절한 명사

  • 문서 제목 및 자막(5자 이상의 모든 주요 단어 및 사전 위치 사용)

  • UI 요소(인터페이스에서 대문자로 표시된 경우에만 해당) 그렇지 않으면 소문자로 사용하십시오.

주의 사항

을 참조하십시오 주의.

자궁 수축

사용 자궁 수축 대화식으로 글을 쓰는 것의 일환으로.

확인("확인" 또는 "확인")

  • "확인"을 사용하여 "확인"을 의미합니다. 필요에 따라 "that"를 포함시킵니다. "그림 주위에 빈 공간이 충분한지 확인하십시오."

  • "ONTAP 클러스터에서 NFS 및 CIFS 볼륨을 프로비저닝할 수 있도록 Cloud Manager를 사용하십시오."라는 약속 또는 보장을 위해 "보장"을 사용해서는 안 됩니다.

  • 사용자가 이미 존재하거나 이미 발생한 항목을 다시 확인해야 할 경우 "클러스터에 NFS가 설정되어 있는지 확인"을 사용하십시오.

그래픽

을 참조하십시오 많은 시각 자료를 사용합니다.

문법

달리 명시된 경우를 제외하고 다음에 설명된 문법, 문장 부호 및 맞춤법 규칙을 따릅니다.

그렇지 않은 경우

"그렇지 않은 경우"는 이전 문장을 참조하기 위해 단독으로 사용하지 마십시오.

  • 이보다는:"컴퓨터가 꺼져 있어야 합니다. 그렇지 않으면 끄십시오."

  • 다음을 수행하십시오.: "컴퓨터가 꺼져 있는지 확인하십시오."

If("여부" 또는 "시기")

  • "If This, then then that" 구조에서 "If"를 사용하여 조건을 나타냅니다.

  • 명시되거나 묵시적인 "여부" 조건이 있을 때 "여부"를 사용합니다. 번역의 편의를 위해 "여부"를 "여부"만으로 바꾸는 것이 가장 좋습니다.

  • "When"을 사용하여 시간이 경과했음을 나타냅니다.

필수 음성

을 참조하십시오 쓰기 활성.

향후 기능 또는 릴리즈

기능 또는 기능이 "현재 지원되지 않음"이라고 말하는 것 외에는 향후 제품 릴리스 또는 기능의 시기나 내용을 언급하지 마십시오.

KB 문서: 참조

해당하는 경우 콘텐츠의 KB(NetApp Knowledgebase) 문서를 참조하십시오. 리소스 페이지 및 GitHub 콘텐츠를 보려면 링크를 러닝 텍스트에 넣으십시오.

목록

일반적으로 정보 목록은 텍스트 블록보다 스캔하고 흡수하기 쉽습니다. 복잡한 정보를 목록 형식으로 제공하여 단순화하는 방법을 고려하십시오. 다음은 몇 가지 일반적인 지침입니다. 하지만 여러분의 판단력을 발휘해 보십시오.

  • 목록의 이유가 명확한지 확인합니다. 전체 문장, 결장이 있는 문장 조각 또는 제목이 있는 목록을 소개합니다.

  • 목록은 2개에서 7개 사이의 항목을 포함해야 합니다. 일반적으로 각 항목의 정보가 짧을수록 목록을 스캔 가능한 상태로 유지하면서 더 많은 항목을 추가할 수 있습니다.

  • 목록 항목은 가능한 한 스캔 가능한 상태여야 합니다. 목록 항목을 스캔 가능한 상태로 유지하는 방식으로 텍스트 블록을 사용하지 않도록 합니다.

  • 목록 항목은 대문자로 시작해야 하며 목록 항목은 문법적으로 평행해야 합니다. 예를 들어, 각 항목을 명사 또는 동사로 시작합니다.

    • 모든 목록 항목이 완전한 문장이면 마침표로 끝마치십시오.

    • 모든 목록 항목이 문장 조각인 경우 마침표로 끝내지 마십시오.

  • 목록 항목은 사전순 또는 시간순으로 정렬됩니다.

로컬리제이션

을 참조하십시오 글로벌 고객을 위한 글을 작성합니다.

미니멀리즘

을 참조하십시오 최소한의 글쓰기.

번호

  • 10보다 큰 숫자와 10보다 큰 모든 숫자에 아라비아 숫자를 사용합니다. 단, 다음 경우는 예외입니다.

    • 문장에 숫자를 사용할 경우 아라비아 숫자가 아닌 단어를 사용합니다.

    • 숫자(숫자 아님)를 사용하여 대략적인 숫자를 확인하십시오.

  • 10보다 작은 숫자에 단어를 사용합니다.

  • 문장에 10보다 작은 숫자와 10보다 큰 숫자가 혼합되어 있는 경우 모든 숫자에 아라비아 숫자를 사용합니다.

  • 추가 번호 규칙은 을 참조하십시오 "Microsoft 작성 스타일 가이드".

표절

NetApp 제품과 NetApp 제품의 상호 작용 및 타사 제품을 문서화합니다. 타사 제품은 문서화되지 않습니다. 타사 콘텐츠를 복사하여 문서에 붙여 넣을 필요가 없으며 절대 그렇게 해서는 안 됩니다.

필수 구성 요소

전제 조건 현재 작업을 시작하기 전에 사용자가 완료해야 하는 조건이나 작업을 식별합니다.

  • "사전 요구 사항", "시작하기 전에" 또는 "시작하기 전에"와 같은 제목으로 콘텐츠의 특성을 식별합니다.

  • 다음과 같은 경우 수동 음성을 사용하여 사전 요구 사항을 확인합니다.

    • "NFS 또는 CIFS가 클러스터에 설정되어 있어야 합니다."

    • "클러스터를 Cloud Manager에 추가하려면 클러스터 관리 IP 주소와 관리자 계정의 암호가 있어야 합니다."

  • 필요한 경우 사전 요구 사항을 명확히 합니다. "NFS 또는 CIFS를 클러스터에 설정해야 합니다. System Manager 또는 CLI를 사용하여 NFS 및 CIFS를 설정할 수 있습니다."

  • 현재 작업의 첫 번째 단계로 콘텐츠를 다시 사용하는 것이 적절한지와 같은 다른 방법으로 정보를 표시할 수 있습니다.

    • 사전 요구 사항: "첫 번째 클러스터를 배포하기 전에 필요한 권한이 있어야 합니다."

    • 단계: "첫 번째 클러스터를 배포하는 데 필요한 권한을 제공하십시오."

이전(대 "이전", "이전" 또는 "이전")

  • 가능한 경우 "이전"을 "이전"으로 교체합니다.

  • "이전"을 사용할 수 없는 경우 "이전"을 형용사로 사용하여 이전에 발생했거나 중요도가 높은 항목을 참조합니다.

  • "Previous"를 사용하여 이전에 지정되지 않은 시간에 발생한 항목을 나타냅니다.

  • "선행"을 사용하여 바로 전에 발생한 항목을 나타냅니다.

구두점

단순성 유지 일반적으로 문장에 구두점이 더 많이 포함할수록 이해에 더 많은 뇌 세포가 필요합니다.

  • 세 개 이상의 항목으로 구성된 설명 목록에서 연관("AND" OR") 앞에 직렬 쉼표(Oxford 쉼표)를 사용하십시오.

  • 세미콜론과 콜론의 사용을 제한합니다.

  • 달리 명시된 경우를 제외하고 다음에 설명된 문법, 문장 부호 및 맞춤법 규칙을 따릅니다.

그 이후로

"Since"를 사용하여 시간이 경과했음을 나타냅니다. "이후"를 "이유"를 의미하기 위해 사용하지 마십시오.

맞춤법

달리 명시된 경우를 제외하고 다음에 설명된 문법, 문장 부호 및 맞춤법 규칙을 따릅니다.

"which" 또는 "who"와 비교)

  • "that"(후행 쉼표 없이)를 사용하여 문장이 이해하기 위해 필요한 절을 소개합니다.

  • 영어로 된 문장이 분명하더라도 "컴퓨터가 꺼져 있는지 확인"을 사용하십시오.

  • "which"(뒤에 쉼표가 있음)를 사용하여 지원 정보를 추가하지만 문장이 이해하기 위해서는 필요하지 않은 절을 소개합니다.

  • "WHO"를 사용하여 사람을 지칭하는 절을 소개합니다.

상표

대부분의 기술 콘텐츠에는 상표 기호가 포함되지 않습니다. 템플릿의 법적 진술만으로는 충분하기 때문입니다. 그러나 을 사용할 때는 모든 사용 규칙을 따릅니다 "NetApp 상표 용어":

  • 상표 용어(기호 포함 또는 제외)는 명사, 동사 또는 자세한 말로 사용할 수 없으며 형용사로만 사용하십시오.

  • 상표 등록된 용어를 약어, 하이픈 넣거나 기울임꼴로 표시하지 마십시오.

  • 상표가 있는 용어를 복수화하지 마십시오. 복수 형식이 필요한 경우 상표 이름을 복수 명사를 수정하는 형용사로 사용합니다.

  • 상표가 있는 용어의 소유격 형식을 사용하지 마십시오. 상표가 아닌 일반적인 의미에서 NetApp 같은 소유 형태의 회사 이름을 사용할 수 있습니다.

사용자 인터페이스

사용자 인터페이스를 문서화할 때는 최대한 인터페이스에 의존하여 사용자를 안내합니다.

일반 지침

UI를 문서화할 때 간단하고 미세한 스타일을 사용합니다.

Details

  • 사용자가 콘텐츠를 읽는 동안 인터페이스를 사용하고 있다고 가정합니다.

    • 사용자에게 단계별 마법사 또는 화면별 단계를 안내하지 마십시오. 인터페이스에서 명확하게 드러나지 않는 중요한 사항만을 말합니다.

    • "확인 클릭", "저장 클릭" 또는 "볼륨이 생성됨" 또는 작업을 수행하는 다른 사람에게 명백한 내용은 포함하지 마십시오.

    • 성공을 거십시오. 대부분의 시간에 작업이 실패할 것으로 예상되지 않는 한, 실패 경로를 문서화하지 마십시오. 인터페이스가 적절한 지침을 제공한다고 가정합니다.

  • "클릭"을 전혀 사용하지 마십시오. 이 단어는 마우스, 터치, 키보드 및 기타 선택 방법을 포괄하므로 항상 "선택"을 사용합니다.

  • 고객 사용 사례를 다루고 워크플로우를 시작하기 위해 인터페이스의 적절한 위치로 사용자를 배치하는 워크플로에 콘텐츠를 집중합니다.

  • 사용자 목표를 달성할 수 있는 가장 좋은 방법을 항상 문서화하십시오.

  • 워크플로에 상당한 결정이 필요한 경우 결정 규칙을 문서화해야 합니다.

  • 대부분의 사용자에게 필요한 최소 단계 수를 사용합니다.

UI 요소 이름 지정

UI 요소의 이름을 지정해야 하는 세분화 수준으로 문서화하지 마십시오.

Details

인터페이스에 의존하여 상호작용의 세부 사항을 사용자에게 안내합니다. 특정 이름을 지정해야 하는 경우 요소의 레이블 이름을 지정합니다. 예를 들어, "원하는 볼륨 선택" 또는 "기존 볼륨 사용"을 선택합니다. 메뉴나 라디오 버튼 또는 확인란에 이름을 지정할 필요가 없으며 레이블만 사용하십시오.

사용자가 선택해야 하는 아이콘의 경우 아이콘 이미지를 사용합니다. 이름을 지정하려고 하지 마십시오. 이 규칙은 화살표, 연필, 기어, kabob, hamburger, 등.

표시된 라벨을 나타냅니다

레이블을 식별할 때 사용자 인터페이스에서 사용하는 철자 및 대/소문자를 따릅니다.

Details

레이블 뒤에 타원이 오는 경우 개체의 이름을 지정할 때 타원을 포함하지 마십시오. 개발자가 쉽게 작성할 수 있도록 사용자 인터페이스 레이블에 제목 스타일의 대문자 표시를 사용하도록 권장합니다.

화면 캡처 사용

화면 캡쳐를 적게 사용합니다.

Details

가끔 화면 캡처("스크린샷")를 사용하면 워크플로 중에 인터페이스를 시작하거나 변경할 때 인터페이스에서 올바른 위치에 있다는 확신을 가질 수 있습니다. 입력할 데이터 또는 선택할 값을 표시하기 위해 화면 캡처를 사용하지 마십시오.

While (대 "browser")

  • "while"을 사용하여 시간 내에 발생한 것을 나타냅니다.

  • 거의 같은 시간 또는 다른 활동 직후에 발생하는 활동을 나타내려면 "도래"를 사용합니다.