🔍[Troubleshooting] 애플리케이션의 요구사항과 API 명세.

• 처음 연락처 애플리케이션을 만들 때 애플리케이션의 요구사항과 API의 명세를 그저 간단하게만 생각하고 넘겨버린 후 바로 코드 작성에 들어갔습니다.

1️⃣ 애플리케이션의 요구사항이 없으니 기준점이 잡히지 않아요.

• 애플리케이션의 요구사항이 없이 바로 코드 작성을 시작하니 기준점 없이 프로젝트를 시작하는것이나 다름이 없었습니다.
  • 정리가 되지 않은 상황에서 그냥 머리에 떠오르는대로 바로 코드를 작성하니 어느 순간부터 코드가 스파게티 코드가 되기 시작했습니다.

2️⃣ 스파게티 코드때문에 생긴 일.

• 예를 들어 설명해보면 처음 DB 테이블을 만들 때, Person이라는 테이블 안에 각 Column을 id, name, phone_number, email으로 생성했습니다.
  • 그 이후에 코드를 작성하는데, “이름”과 “성”을 따로 나눠야 하는 상황들이 연속해서 생기기 시작했습니다.
    • 1. 사용자가 성 없이 이름만 저장하고 싶은 경우.
    • 1. 사용자가 검색시 성으로만 검색할 경우.
    • 1. 사용자가 검색시 이름으로만 검색할 경우.
         • 이와 같은 여러 상황이 있을 수 있는 것을 미쳐 생각하지 못해 DB와 코드를 수정해야하는 상황이 발생했습니다.

3️⃣ 해결책과 실행 그리고 느낀점.

• 이후부터는 바로 애플리케이션의 요구사항과 각 API의 명세를 작성하는데 시간을 투자했습니다.
• 요구사항과 API 명세를 작성하면서 생기는 장점은 머리 속에서 코드를 어떻게 작성해야 할지 미리 생각을 할 수 있었습니다.
  • 또한 구조는 어떻게 만들어야 하는지도 생각을 미리 할 수 있었습니다.
• 요구사항과 API 명세를 작성하는데 시간이 정말 많이 걸렸습니다.
  • 오히려 코드를 작성하는데 시작이 짧게 걸렸습니다.
    • 이미 요구사항과 API 명세를 작성하면서 머리 속에서 정리가 되었고, 기준점이 생겼으며 만들어 놓은 요구사항과 API 명세대로 작성하다보니 코드를 수정하는 시간이 정말 짧아지거나 아에 없을 때도 있었습니다.
• 요구사항과 API 명세에 투자하는 시간에 깊은 집중력과 좋은 효율로 인풋을 내어야 한다고 느꼈으며 깨달았습니다.