← 목록

2025-07-21 · 강나래

내부 개발자 포털 문서의 톤앤매너 가이드 초안

플랫폼 팀이 작성하는 가이드가 왜 항상 딱딱해지는지, 그리고 실무자가 원하는 밀도는 무엇인지 현장 피드백을 바탕으로 정리했습니다.

내부 개발자 포털 문서의 톤앤매너 가이드 초안
문서의 목적이 "법적 면책"에 가까워지면 독자는 스킵합니다. 반대로 유머만 과하면 검색 가능성이 떨어집니다. 내부 포털에서는 명령 블록과 실패 메시지 예시를 최상단에 두고, 배경 설명은 접이식 섹션으로 내리는 패턴이 잘 먹힙니다. 용어는 제품 코드베이스와 동일한 스펠링을 유지하세요. 한글과 영문 혼용 시 첫 등장에서 병기하면 검색 품질이 좋아집니다. 마지막으로 "알려진 제한" 소절을 빼지 마세요. 독자는 한계를 알 때 더 신뢰합니다.