컬럼/에세이
온보딩 문서의 세 줄
박
박지훈
2026-10-09 09:39
115
지난 화요일 오후, 판교 사무실 자리에서 S님 화면을 같이 봤습니다. 개발환경 문서의 중간쯤이었습니다. 설치는 거의 끝났는데 다음에 뭘 확인해야 하는지 알 수 없는 상태였습니다.
문서는 길었습니다. 명령어와 캡처도 충분했습니다. 어디까지 되면 첫 실행이 끝난 것인지, 권한이 없으면 누구에게 말해야 하는지는 찾기 어려웠습니다.
맨 위에 붙인 문장
기존 안내 위에 세 줄을 추가했습니다. 로컬 서버 실행 후 상태 확인 주소에서 200 응답을 볼 것. 저장소와 테스트 계정 권한은 플랫폼 담당자에게 요청할 것. 첫 주에는 운영 배치 설정을 수정하지 않을 것.
설치 순서보다 완료 기준과 문의처를 먼저 둔 셈입니다. 설명하는 저도 어디서부터 다시 봐야 할지 덜 헤맸습니다.
다음 날
S님은 같은 문서를 다시 열고 필요한 권한부터 요청했습니다. 오전 중에 첫 실행도 끝났습니다. 문서를 줄인 게 아니라 입구에 표지판만 세운 건데 차이가 있었습니다.
다만 세 줄이면 충분하다고 적어 놓고 나니 좀 찜찜합니다. 예외 상황을 너무 접어 둔 건 아닌지, 새로 들어오는 사람이 질문할 기회까지 줄인 건 아닌지 모르겠습니다.
오늘 아침 셔틀에서 다시 읽어 봤습니다. 세 줄 아래에는 예전 설명이 네 화면쯤 그대로 남아 있습니다.
첨부 이미지 (1개)
