피드로 돌아가기
Before Writing Code, I Write the Spec Myself
Dev.toDev.to
Backend

Before Writing Code, I Write the Spec Myself

개발자가 클라이언트 요구사항을 명확한 사양 문서로 구조화하여 팀 간 커뮤니케이션 회차 감소 및 재작업 제거

koreanDev2026년 3월 23일6beginner

Context

소규모 회사에서는 기능 사양서나 API 문서가 없는 경우가 많아 개발자가 불명확한 요구사항을 직접 정리해야 했다. 특히 개발자가 아닌 담당자로부터 받은 요구사항은 구조화되지 않았고, 백엔드와 프론트엔드 간 커뮤니케이션이 명확하지 않아 문제가 발생했다.

Technical Solution

  • 사용자 상태를 명확한 상태 모델로 분류: guest(active && none), pending user(pending && not_submitted/submitted/rejected), active user(active && approved)
  • Confluence 문서를 단일 참조 소스로 작성: 담당자는 사용 사례 검증, 백엔드 개발자는 반환 상태값 확인 가능
  • 요구사항 변경 시 일대다 메시징 대신 문서 업데이트로 통일: 한 개 문서에서 세 명이 참조하는 구조로 변경

Key Takeaway

불명확한 구두 요구사항을 먼저 명확한 상태 모델과 문서로 구조화하면, 팀 간 합의 검증이 가능해지고 요구사항 변경 추적이 단순화되며 재작업이 감소한다.


백엔드 개발 초기 단계에서 상태 머신(State Machine)을 Confluence나 유사 도구로 문서화하고 팀 전체가 공유하면, 구두 커뮤니케이션으로 인한 상태값 불일치 문제를 사전에 방지할 수 있다.

원문 읽기