InfoGrab DocsInfoGrab Docs

이미지, 다이어그램, 아이콘

GitLab 문서의 스크린샷, 다이어그램, 아이콘에 관한 규칙을 설명합니다.

삽화 # GitLab 문서는 두 가지 유형의 삽화를 사용합니다. 스크린샷: GitLab 사용자 인터페이스의 일부를 보여 주는 데 사용합니다. 다이어그램: 프로세스나 개체 간의 관계를 설명하는 데 사용합니다. 삽화는 독자가 개념, 복잡한 프로세스에서 자신의 위치, 또는 애플리케이션과 상호 작용하는 방법을 이해하는 데 도움이 될 수 있습니다. 다음과 같은 이유로 삽화는 최소한으로 사용합니다. 시간이 지나면 오래된 정보가 됩니다. 현지화하기 어렵고 비용이 많이 듭니다. 스크린 리더가 읽을 수 없습니다. 문서에 삽화를 꼭 사용해야 한다면 삽화는 다음 조건을 갖춰야 합니다. 텍스트를 보완하되 대체하지 않아야 합니다. 독자가 필요한 정보를 얻기 위해 삽화에만 의존해서는 안 됩니다. 앞선 텍스트에 도입 문장이 있어야 합니다. 예를 들어 The following diagram illustrates the product analytics flow: 입니다. 접근할 수 있어야 합니다. 자세한 내용은 스크린샷과 다이어그램에 관한 지침을 참고합니다. 개인 식별 정보를 제외해야 합니다. 스크린샷 # 관련 정보 중 일부를 텍스트로 전달할 수 없을 때 스크린샷으로 GitLab 사용자 인터페이스의 일부를 보여 줍니다. 스크린샷 캡처 # 스크린샷을 찍을 때는 다음을 따릅니다. 스크린샷의 콘텐츠가 GitLab SAFE 프레임워크 를 준수하는지 확인합니다. 확인하려면 SAFE 플로차트 를 따릅니다. 가치를 제공하는지 확인합니다. lorem ipsum 텍스트를 사용하지 않습니다. 실제 시나리오에서 기능이 어떻게 사용될지 재현하고, 현실적인 텍스트를 사용합니다 . 관련 UI만 캡처합니다. 불필요한 공백이나 요점을 설명하는 데 도움이 되지 않는 UI 영역은 포함하지 않습니다. GitLab의 사이드바는 바뀔 수 있으므로 꼭 필요한 경우가 아니면 스크린샷에 포함하지 않습니다. 작게 유지합니다. 화면 전체 너비를 보여 줄 필요가 없다면 보여 주지 않습니다. 브라우저 창 크기를 최대한 줄여 요소들을 가까이 두고 빈 공간을 줄입니다. 스크린샷의 크기를 가능한 한 작게 유지합니다. 이미지가 페이지에서 어떻게 렌더링되는지 검토합니다. 이미지를 로컬에서 미리 보거나 머지 리퀘스트의 리뷰 앱을 사용합니다. 이미지가 흐릿하거나 부담스럽지 않은지 확인합니다. 일관성을 유지합니다. 일관된 읽기 경험을 위해 문서 페이지에 이미 있는 다른 스크린샷과 맞춥니다. 탐색 테마가 기본 설정인 Neutral 로, 구문 강조 테마도 기본 설정인 Light 로 설정되어 있는지 확인합니다. 콜아웃 추가 # 스크린샷에서 한 영역을 강조하려면 화살표를 사용합니다. 색상은 #EE2604 를 사용합니다. macOS의 미리 보기 애플리케이션을 사용한다면 이 색이 기본 빨간색입니다. 선 굵기는 3pt를 사용합니다. macOS의 미리 보기 애플리케이션을 사용한다면 목록의 세 번째 선입니다. 다음 이미지에 나온 화살표 스타일을 사용합니다. 화살표가 여러 개라면 가능한 한 서로 평행하게 만듭니다. 이미지 요구 사항 # 너비나 높이