개발자의 글쓰기

∕  2023-03

 

 

 

 

---

 

 

 

1. 주석에 대하여

이렇게 주석을 달지 말자!

// 사용자가 레벨업하려면 로그인을 10회 이상하고 게시물을 5개 이상 작성해야한다.
if(user.getLoginCount() && user.getOwnArticleCount() >= 5) {
    int level = user.getLevel();
    user.setLevel(level++);
}

 

이렇게 변경하는 것이 좋다.

// 승급 조건이 되면 승급한다.
if(user.getLoginCount() && user.getOwnArticleCount() >= 5) {
    int level = user.getLevel();
    user.setLevel(level++);
}

// 하지만 이렇게 리팩토링 하는 것이 더 좋다.
if(user.enoughToLevelUp()) {
    user.levelUp();
}

 

 

 

2. UI의 개선

- 로그인 n회 이상 시 자동입력방지문자를 입력해야하는 정책이 있다면, 사용자가 신중하게 입력할 수 있도록 남은 로그인 시도 횟수를 보여준다.

- 달력을 선택할 때 다음 날짜는 사용자가 선택한 날짜보다 이전으로 선택할 수 없게끔 한다.

- 카드번호 입력 시 4개씩 입력하게하여 오입력의 가능성을 줄인다.

- Caps Lock이 켜진 경우 미리 경고한다.

 

이렇게 서비스와 사용자를 이해하면 에러 메시지 대신에 예방 메시지를 보여줌으로써 에러 발생을 막을 수 있다. 처음부터 에러 메시지를 예방 메시지라고 생각하면 에러를 없애는 단순 개발자가 아니라 사용성을 높이고 서비스를 활성화하는 비즈니스 감각이 있는 개발자가 될 것이다.

 

이것은 결국 철학의 문제다. 개발자가 사용자를 불완전한 존재로 인식하는 순간 모든 사용자의 행동에 경고로 대응한다. 그러면 시스템도 불완전해진다. 어떤 방식을 쓸지는 서비스와 사용자에 따라 달라지겠지만, 개발자도 자신만의 철학을 가져야 한다.

 

 

 

3. 체인지 로그를 분류, 요약, 종합하는 법

넘 웃기닼ㅋㅋㅋㅋㅋㅋㅋㅋㅋ 

"버그 많은 거 자랑하시나요?"

ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ ㅠ

 

체인지 로그의 양을 줄이려면 체인지 로그 중에서 쓸 것과 없앨 것을 구분하는 기준이 필요하다. 이 때 개발자는 보통 자기가 오랜 시간을 들여 노력한 것을 쓰고, 그렇지 않은 것은 빼는 경향이 있다. 하지만 이런 기준으로 체인지 로그를 선정해서는 안된다. 체인지 로그를 보는 독자의 입장은 다를 수 있기 때문이다.

 

따라서 아래와 같은 기준으로 작성하는 것을 추천한다.

 

 

 

 

"그래서 한마디로 뭘 했다는 거죠?" 라는 질문에 답할 수 있어야 한다. 그래서 체인지로그의 첫 줄에 간략화하여 적는 것이 좋다.

 

게임방에 더 빨리 입장하고 게임 결과를 바로 확인할 수 있도록 다음과 같이 변경했습니다. → 2가지 이상이므로 줄을 나누고 제목을 넣는다.

 

// 종합한 내용을 첫 줄에 적는다. 1순위로 정했던 회사와 개발자가 말하고싶고 독자가 듣고 싶은 1순위 체인지 로그의 특성과 결과를 발췌한다. [사용자 편리성 개선] 1) 게임방에 더 빨리 입장 2) 게임 결과 바로 확인 // 개조식으로 작성하고 사용자의 입장 or 보고받는 사람의 입장에서 정리해야한다. [세부 내용] 새로운 기능 추가 닉네임을 만들 때 특수문자를 입력하는 기능 추가 → 다양한 닉네임을 설정함으로서 자기를 더 잘 표현 빈 게임방을 자동으로 검색하는 기능 추가 → 게임 준비 시간 절감 기능 개선 최근 기록이 상위에 올라오도록 개선 → 게임 결과를 더 쉽게 확인 오류 수정 고해상도 폰에서 아이콘이 찌그러지는 오류 수정 → 정확한 사용 애니메이션 스티커가 갑자기 멈추는 오류 수정 → 정확한 사용