이 질문 뒤에 면접관이 확인하려는 것은 따로 있습니다.
문서 작성 경험에서 가장 많이 작성한 것은 API 문서였습니다. Swagger로 자동 생성되는 부분 외에도 요청/응답 예시와 에러 케이스 설명을 수동으로 추가해야 실제로 유용한 문서가 됐습니다. 코드와 함께 관리되는 문서가 항상 최신 상태를 유지하기에 유리했습니다.
기술 명세서 작성도 경험했습니다. 새 기능을 개발하기 전 설계 의도와 트레이드오프를 정리한 문서를 먼저 작성하면 팀원들이 구현 방향을 미리 검토할 수 있었고, 나중에 왜 이렇게 만들었는지 설명하는 시간이 줄었습니다.
회의록은 결정 사항과 담당자를 명확히 기록하는 방식으로 작성했습니다. 회의 내용을 전부 받아쓰기 하는 것보다 누가 무엇을 언제까지 한다는 액션 아이템 중심으로 정리하면 후속 추적이 수월했습니다.
API 문서를 처음 작성했을 때 "내가 이해한 것"을 그대로 썼더니 팀원이 헷갈려하는 일이 생겼습니다. 엔드포인트 목록과 파라미터는 있었는데, "어떤 순서로 호출하면 되는가"가 빠져 있었습니다.
이후엔 처음 보는 사람이 30분 안에 API를 써볼 수 있는가를 기준으로 삼았습니다. curl 예시 코드를 먼저 넣고, 응답 샘플과 에러 코드별 의미를 함께 두니 팀 내 질문이 눈에 띄게 줄었습니다.
이 경험으로 문서는 정보를 담는 것보다 읽는 사람이 행동할 수 있게 안내하는 것이 목적이라고 생각하게 됐습니다. 내가 쓴 문서를 처음 보는 팀원에게 읽게 해보고 어디서 막히는지 직접 확인하는 방식도 추가했습니다.
문서 작성에서 가장 어려운 것은 쓰는 것보다 최신 상태로 유지하는 것이라는 걸 경험했습니다. API가 바뀔 때마다 문서를 업데이트하는 것을 깜빡하거나, 누가 업데이트할지 정해지지 않아 문서가 코드와 달라지는 경우가 생겼습니다.
이후엔 문서를 코드와 가깝게 두는 방식을 택했습니다. docstring으로 함수 설명을 붙이고, Swagger로 API 스펙을 자동 생성하는 구조로 바꾸니 코드가 바뀌면 문서가 함께 바뀌는 흐름이 됐습니다.
이 경험으로 좋은 문서는 관리 의지가 아니라 관리하기 쉬운 구조에서 나온다는 걸 배웠습니다. 사람이 기억하는 것보다 구조가 강제하는 것이 오래 갑니다.
답변에서 흔히 빠지는 것들 — 빠져 있으면 꼬리질문이 깊어집니다.
이 질문에 이어 SPC그룹 경영기획 면접관이 던질 가능성이 높은 후속 질문.
이 페이지의 질문·답변·꼬리질문은 유사 직군 채용 시장의 공개된 면접 후기·커뮤니티 게시물을 분석해 구성한 학습 자료입니다. 특정 회사가 실제로 이 질문을 출제했다는 것을 보장하지 않으며, 모든 예시는 우문현답이 직접 작성한 창작물입니다. 해당 회사의 공식 입장과는 무관합니다. 회사 측의 정정 요청이 있을 경우 24시간 이내에 응답·수정합니다.