Discourse 문서 및 UI의 텍스트 서식 지정

:information_source: 현재 Discourse UI 및 문서가 이러한 가이드라인에 부합하도록 검토 및 편집되고 있습니다. 최대한 신속하게 완전한 정합성을 달성하기 위해 노력하고 있습니다.

Discourse에 글을 쓸 때는 텍스트 서식을 위한 다음 가이드라인을 숙지하십시오. 이 가이드라인은 문서와 Discourse UI를 포함한 모든 영역의 텍스트에 적용됩니다.

대소문자 구별

문서나 UI 텍스트를 작성할 때는 기본적으로 문장체(첫 단어의 첫 글자만 대문자, 나머지는 소문자)를 사용하십시오.

중요한 참고 사항:

  • 제목, 표제 및 카테고리 이름에는 문장체를 사용합니다.
  • Discourse 기능 이름은 대문자를 사용하지 않으며, 다음 예외만 해당됩니다:

기능 이름에는 볼드, 이탤릭, 백틱, 따옴표 등 다른 어떤 서식도 사용하지 마십시오.

대소문자 구별 예외 사항:

  • 약어는 항상 적절하게 대문자로 표기해야 합니다.
  • 제품 및 브랜드 이름은 해당 브랜드 가이드라인에 따라 대문자로 표기해야 합니다.
  • 플러그인 및 테마 이름은 적절하게 대문자로 표기해야 합니다.
  • 메뉴 항목, 버튼 라벨 또는 양식 옵션을 언급할 때는 첫 단어의 첫 글자를 대문자로 표기합니다. 예: “작성을 시작하려면 새 주제 버튼을 클릭하십시오.”
  • UI에서 좋은 이유로 대문자가 사용된 경우, 해당 항목에 대한 문서를 작성할 때에도 동일한 대소문자 구별을 사용하십시오.
  • 카테고리 및 URL 슬러그는 항상 소문자로 표기합니다.

의심이 들면 문장체를 사용하십시오.

마침표

다음 항목에는 마침표를 사용하지 마십시오:

  • 문장 하나만 포함된 툴팁, 이미지 캡션 또는 기타 UI 요소
  • 버튼 라벨
  • 메뉴 항목
  • 동사가 없는 목록 항목

다음 항목에는 마침표를 사용하십시오:

  • 일반 문장
  • 문장 두 개 이상 포함된 툴팁, 이미지 캡션 또는 기타 UI 요소
  • 동사가 포함된 목록 항목
  • 이미지 alt 텍스트

목록 항목에 대한 주의 사항: 혼합된 항목(일부는 마침표가 필요하고 일부는 필요하지 않음)으로 된 목록을 작성하는 경우, 모든 항목에 마침표를 사용하십시오.

강조

단어를 강조할 때는 기본적으로 이탤릭을 사용하십시오. 상황에 맞게 볼드도 사용할 수 있습니다.

백틱

인라인 코드, 예시 URL 및 설정 이름에는 백틱(``)을 사용하십시오. 기타 목적으로는 사용하지 마십시오.

코드 블록

코드 블록을 포함할 경우, 가능한 한 코딩 언어를 지정하십시오. 이를 위해 시작 펜스(첫 번째 세 개의 백틱) 바로 뒤에 언어를 추가합니다. 예: ```css.

5개의 좋아요

Data Explorer는 플러그인 이름이므로, 다음 내용에 따라

해당 사항이 아닌가요?
버튼의 정확한 표기를 사용하지 않는 이유는 무엇인가요? 이렇게 하면 제가 해당 버튼을 식별하기가 더 쉬워집니다.
New Topic

최근 여기에서도 이렇게 처리되었습니다.

1개의 좋아요

맞습니다. 하지만 Discourse에서 다소 독특한 기능이기 때문에 여기서 별도로 언급하는 것이 가치가 있다고 생각했습니다.

버튼의 정확한 표기법을 사용해야 하는 것은 분명합니다. 하지만 애초에 버튼 자체는 그렇게 표기되어서는 안 됩니다. 이 가이드라인은 모든 UI 요소와 문서에 적용됩니다. 이를 위해 Discourse를 이 가이드라인에 맞게 점진적으로 업데이트할 예정입니다. 이 과정에는 시간이 걸릴 수 있으므로, 모든 업데이트가 완료될 때까지 문서의 대소문자 표기와 UI의 대소문자 표기 사이에 약간의 불일치가 발생할 수 있습니다.

1개의 좋아요

참고로, 이는 UX: Use correct case for "Add Flag" button - Pull Request #29505 - discourse/discourse - GitHub 에서 수정되었습니다.

1개의 좋아요