독자 관점에서 릴리즈 노트 작성하기 요즘 내가 가장 자주 작성하는 문서 중 하나이다. 여기서도 내가 원하는 중간을 가기가 생각보다 어렵다. 시간을 써서 자잘한 버그를 엄청 많이 잡아내면 뭔가 릴리즈 노트에 이런 내용을 다 적고 싶다. 하지만, 이런 버그 하나하나 모두 적게되면 독자 입장에서 읽기도 싫고 이렇게 버그가 많은 게 자랑인가 싶을 것이다. 반대로 '사소한 버그들을 수정했다'는 한 문장으로 퉁치는 순간 일한 보람도 없고 인정받기도 힘들다. 그래서 우선 순위를 정하여 릴리즈 노트를 작성해야 한다. 여기서 독자를 고려해 우선 순위를 정해야 하는데 독자는 회사가 될 수도 있고, 일반 소비자가 될 수도 있다. 독자가 관심있게 볼 내용과 관심도가 떨어지는 내용을 구분하여 다르게 작성해야 한다. 이것으로 이..
이번 글의 시작은 에러 메시지에 관한 내용이다. 사용자와 소통하는 에러 메시지 작성하기 웹 페이지에서 가장 자주 볼 수 있는 에러 404. 404 에러 화면에서도 사용자의 평가가 갈릴 수 있다. 구글의 404 화면을 보면 상당히 심플한데 이를 실제로 불편해하는 사용자도 있다. (사용자 본인이 링크를 잘못 입력한 것인지, 구글이 페이지를 삭제하는 바람에 에러 화면을 마주하게 된 것인지 모르기 때문) 반면, 위키피디아의 404 화면에는 사용자가 의도한 URL을 추측해서 제안하기도 한다. 친절하게도 우리나라의 경우에는 고객센터로 문의하는 링크가 포함되어 있는 경우가 대부분이다. 여기서 404 에러는 고객에게 죄송해야할까? 이것은 경우에 따라 다르다. 사용자가 URL을 잘못 입력한 경우에는 개발자가 죄송할 이유..
저번에 예고했던 대로 변수와 함수 이름을 짓는 법을 소개하는 것으로 이번 글을 시작하도록 하겠다. 변수 이름 짓기 우리는 흔히 반복문이나 배열 인덱스에 i라는 변수를 자주 사용한다. 이는 integer나 index의 첫 글자로 간주되므로 이상할 것이 없다. 하지만, d라는 변수가 있다면 해당 코드를 읽는 사람은 어떻게 받아들여야 할까? day? double? date? 책에서 소개하길 일자를 뜻하는 변수를 설정하고 싶다면 그냥 day를 사용하면 된다. 하지만, 우리가 어떤 프로그램이던 그냥 day란 없을 것이다. today? selectedDay? finalDay? 등 특정한 의미를 부여해 사용해야 한다. 변수 이름을 지을 때 고려할 또 하나의 척도가 있다. 바로, 검색이 용이한 이름이다. IDE가 발전..