After Work Wiki

결정 기록 · 결정 기록

ADR-0005: Wiki 디자인 시스템

긴 문서와 근거를 빠르게 읽기 위한 색상, 글자, 간격, 상태 표시와 문서 컴포넌트 기준을 정의한다.

상태
확정
신뢰도
높음
근거
3개
업데이트

목표#

이 Wiki의 한 가지 일은 팀원이 긴 조사 문서에서 결론, 근거 수준과 다음 행동을 빠르게 찾도록 돕는 것이다. 제품 홍보용 랜딩 페이지와 달리 장식, 감성 이미지와 전환 유도는 우선하지 않는다.

방향#

디자인 방향은 근거가 보이는 작업 문서다. 흰 종이와 회색 구분선을 기본으로 쓰고, 파란색은 링크와 확인된 근거 흐름에만 사용한다. 검토가 필요한 상태는 황갈색, 갱신이 필요하거나 링크가 깨진 상태는 붉은색으로 구분한다.

각 문서 제목 왼쪽의 얇은 선과 제목 아래 상태줄은 장식이 아니다. 문서를 읽기 전에 상태, 신뢰도, 근거 수와 업데이트일을 확인하는 공통 장치다.

색상 토큰#

이름 사용 범위
Ink #202428 제목과 핵심 본문
Muted #5F6670 요약, 보조 설명과 라벨
Paper #FFFFFF 기본 배경
Fog #F6F8FA 표 머리글, 코드와 보조 영역
Evidence #255F99 링크, 현재 위치와 확인된 문서 상태
Review #8B5A00 수집 중이거나 확인이 필요한 상태

안정 상태에는 녹색, 갱신 필요와 깨진 링크에는 붉은색을 제한적으로 사용한다. 컴포넌트에서 색상 값을 직접 입력하지 않고 :root의 토큰만 참조한다.

글자 체계#

모든 역할은 Pretendard로 통일한다. 다른 글꼴로 개성을 추가하지 않고 크기, 굵기, 줄 간격과 숫자 정렬로 역할을 구분한다.

역할 기본 크기 기준
문서 제목 32~40px 반응형 한 화면에서 문서 주제를 먼저 파악
큰 절 제목 24px 주요 질문이나 결론 구분
작은 절 제목 19px 큰 절 안의 세부 논점
본문 17px 줄 간격 1.7, 읽기 폭 약 43.5rem
14px 본문보다 조밀하지만 13px 아래로 줄이지 않음
라벨과 캡션 13~14px 상태, 출처와 보조 설명

날짜, 출처 번호와 수치는 같은 Pretendard에서 고정폭 숫자 기능을 사용한다.

간격과 레이아웃#

  • 기본 간격은 4, 8, 12, 16, 24, 32, 48, 64px 단계로 제한한다.
  • 일반 본문은 약 43.5rem, 이미지와 전체 문서 영역은 약 58rem을 넘지 않는다.
  • 문서 메뉴는 필요할 때 여는 서랍으로 유지한다.
  • 문서 정보, 목차와 출처는 기본 본문보다 먼저 시선을 끌지 않는다.
  • 모바일에서도 본문은 한 열이며 표만 내부 가로 스크롤을 허용한다.

문서 컴포넌트#

제목 영역#

문서 분류, 제목, 한 문장 요약, 상태줄 순서로 표시한다. 상태줄은 상태, 신뢰도, 근거 수와 업데이트일을 포함한다. 홈은 상태줄을 생략한다.

본문#

제목 단계는 h1부터 순서대로 사용한다. 링크와 인용 번호는 Evidence 색상을 사용하고, 본문의 굵은 글자는 결론이나 판단에만 제한한다.

#

표는 카드처럼 감싸지 않고 위아래 기준선과 행 구분선으로 읽는다. 4열 이상은 본문 폭 안에서 가로로 스크롤하며 키보드 초점 표시를 제공한다.

이미지와 차트#

이미지는 본문 폭을 넘지 않는다. 자료 종류, 한계, 원본 보기와 자료 정보가 항상 캡션에 표시돼야 한다.

상태#

수집 중, 초안, 검토됨, 확정, 갱신 필요를 같은 이름과 색으로 제목 영역, 문서 정보와 검색 결과에서 반복한다.

사용하지 않는 것#

  • 장식용 그라데이션, 큰 그림자와 배경 패턴
  • 문서마다 다른 카드 스타일과 색상
  • 읽는 흐름과 무관한 애니메이션
  • 13px보다 작은 표 본문
  • 컴포넌트 안에 직접 입력한 색상 값

접근성 기준#

  • 키보드 초점은 모든 링크와 조작 요소에서 보여야 한다.
  • 본문 바로가기, 메뉴 상태와 대화상자 이름을 유지한다.
  • 작은 화면에서도 문서 제목, 상태줄과 표가 화면 밖으로 넘치지 않아야 한다.
  • 움직임 줄이기 설정에서는 부드러운 스크롤과 전환을 사실상 제거한다.
  • 인쇄 시 메뉴, 검색과 문서 도구를 숨기고 본문과 출처가 이어지게 한다.

자동 확인#

npm --prefix tools/wiki-publisher run check는 일반 문서 검증과 빌드 뒤 디자인 시스템 검사를 실행한다. 필수 토큰, 컴포넌트의 직접 색상 입력, 상태줄, 검색 상태 이름, 키보드 초점, 움직임 줄이기와 인쇄 규칙을 확인한다.

관련 문서: ADR-0002: Pretendard 타이포그래피 시스템, ADR-0003: Wiki 읽기 인터페이스, ADR-0004: Wiki 정보 구조와 시각 자료

제목, 요약, 태그, 본문을 검색합니다.