Skip to content

docs: bold 마커와 콜론(:) 사이의 공백 스타일 표준화 #843

@jk-kim0

Description

@jk-kim0

배경

Confluence에서 변환된 MDX 문서에서, bold 마커(**)와 콜론(:) 사이의 공백 처리가 일반적인 문서 작성 스타일과 다른 패턴으로 출력되고 있습니다.

현재 상태 (Confluence 변환 산출물)

* **세분화된 접근 제어 :** 사용자 접근 권한을 네트워크...
* **통합 인터페이스 :**  웹 브라우저로 제공되는...
  • 콜론 앞에 불필요한 공백: `제어 :`
  • bold 닫힘(``)과 콜론 사이에 공백: ` :`
  • 콜론 뒤에 이중 공백: `: 설명`

영향 범위

언어 `** :` 패턴 출현 수
ko 1,487건
en 396건
ja 381건

전체 3개 언어에 걸쳐 약 2,264건이 해당됩니다.

권장 스타일 가이드

기본 규칙: `용어: 설명` 또는 `용어: 설명`

콜론 앞에는 공백을 넣지 않으며, 콜론 뒤에는 공백 1개만 사용합니다.
콜론을 bold 안에 포함할지 밖에 둘지는 선택 사항이나, 프로젝트 내에서 일관성을 유지해야 합니다.

# Before (현재 — Confluence 변환 산출물)
* **세분화된 접근 제어 :** 사용자 접근 권한을...
* **통합 인터페이스 :**  웹 브라우저로 제공되는...

# After — Option A: 콜론을 bold 안에 포함
* **세분화된 접근 제어:** 사용자 접근 권한을...
* **통합 인터페이스:** 웹 브라우저로 제공되는...

# After — Option B: 콜론을 bold 밖에 배치
* **세분화된 접근 제어**: 사용자 접근 권한을...
* **통합 인터페이스**: 웹 브라우저로 제공되는...

주요 스타일 가이드 참조

Google Developer Documentation Style Guide — Lists

End the run-in heading with a period or a colon, but be consistent within the list.
You can decide whether to bold the punctuation that ends the heading.

  • 콜론의 bold 포함 여부는 작성자의 선택 사항으로, 리스트 내 일관성을 강조합니다.
  • 예시에서는 `Big: a short word` 형태 (콜론을 bold 밖에 배치)를 사용합니다.

Microsoft Writing Style Guide — Formatting punctuation

In general, format punctuation in the same font style as the main content of a sentence or phrase.
If the punctuation is not part of the element, format the punctuation the same as the main text.

  • 콜론이 UI 요소의 일부가 아닌 경우, 본문 텍스트와 동일한 스타일(plain text)로 표기합니다.
  • 예시: `Enter Balance due: in cell A14.` — 사용자가 입력하는 콜론은 bold 포함.
  • Description list에서는 bold 용어 뒤에 마침표를 사용하며, 마침표는 plain text로 표기합니다.
    (Text formatting guidelines)

근거 정리

  1. 콜론 앞 공백 제거: 한국어·영어·일본어 모두 콜론 앞에 공백을 넣지 않는 것이 표준입니다. 현재의 `** :` 패턴은 Confluence 변환 과정의 부산물입니다.
  2. 콜론 뒤 단일 공백: Markdown 일반 관례에 따라 콜론 뒤에는 공백 1개만 사용합니다.
  3. 콜론의 bold 포함 여부: Google/Microsoft 가이드 모두 "선택 사항이나 일관성 유지"를 권장합니다. 프로젝트 내에서 하나의 방식을 선택하여 통일해야 합니다.

적용하지 않는 경우

  • 테이블 셀 내부의 bold + 콜론 (테이블 정렬 규칙을 따름)
  • 코드 블록 내부
  • 인용문이나 제목에서 의도적으로 사용한 경우

작업 내용

  1. 콜론의 bold 포함 여부(Option A vs B) 결정
  2. `confluence-mdx` forward converter에서 결정된 스타일로 출력하도록 변환 로직 수정
  3. 기존 ko/en/ja 문서를 재생성하여 일괄 반영
  4. 수동으로 작성된 문서(예: `api-reference.mdx`)가 이미 올바른 스타일인지 확인

참고

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions