경험 기반 구체화
기술 내용을 일반 사용자에게 설명할 때는 독자의 전제 지식을 먼저 파악하는 것이 핵심입니다. 같은 기능 설명이라도 IT 담당자와 비전공 사용자에게는 전혀 다른 언어로 써야 합니다. 학교 수업에서 API 문서 초안을 작성한 적이 있는데, 개발자 용어를 그대로 쓴 버전과 비유로 풀어 쓴 버전을 비교했을 때 비전공자 피드백이 크게 달랐습니다. 저는 복잡한 개념을 설명할 때 일상 비유를 먼저 찾는 편인데, '이건 마치 ~와 같다'는 구조가 독자의 이해 속도를 빠르게 높입니다. 또 스크린샷과 단계별 번호를 함께 쓰면 글만 있을 때보다 오류 발생률이 낮아진다는 것도 경험으로 알고 있습니다.
독자가 행동으로 옮길 수 있는 설명이 좋은 기술 문서라고 생각합니다.