독자 수준 + Why 먼저 + 한 문단 한 주제
약 60초
다이어그램 병행 + 버전 이력 남기기
기술 문서를 작성할 때 가장 중점을 두는 건 독자의 배경 지식 수준 맞추기입니다. 구현 담당자를 위한 API 문서와 기획자를 위한 시스템 설명 문서는 세부 수준이 달라서, 같은 내용도 대상에 따라 다르게 씁니다. 코드 예시나 다이어그램을 텍스트와 함께 쓰면 추상적인 설명보다 이해 속도가 빨랐습니다.
Why 먼저 What 나중 순서를 지키는 것도 중요한데, 왜 이 구조가 선택됐는지를 먼저 쓰면 독자가 의도를 파악한 뒤 세부 사항을 읽게 됩니다. 업데이트 이력과 날짜를 문서에 남겨두면 나중에 변경 맥락을 추적할 수 있어 팀 협업에 유용했습니다. 한 문단 한 주제 원칙을 지키면 검색과 수정이 쉬워졌고, 긴 문서일수록 목차를 앞에 두는 게 독자 부담을 줄였습니다.
이 결의 특징
게임 기술 문서 작성에서 누가 읽을 것인지를 먼저 정하는 방식이 핵심입니다. 개발자를 위한 문서와 기획자를 위한 문서는 같은 내용이라도 구성 방식과 깊이가 달라야 한다는 인식이 특징입니다.
이 결이 통하는 자리
게임 기술 문서 작성 방식을 묻는 포지션에서 자주 등장하는 질문입니다. 독자 기준으로 문서 구성을 달리하는 방식이 있는 답은 면접관이 문서 작성 방식을 확인하는 자리입니다.