개발자의 글쓰기
-
개발자의 글쓰기 - 릴리스 노트, 장애 보고서책책책 책을 읽읍시다/프로그래밍 2023. 8. 11. 22:25
고객에게 유용한 정보를 쓰자 개발자 관점과 고객 관점 체인지 로그는 개발자가 변경한 내용을 적은 것이다. 하지만 체인지 로그를 보는 독자는 뭔가 새로운 것, 바뀐 것, 그래서 자기에게 좋거나 유익하거나 어떤 행동을 해야 할지 명확하게 지시하는 것을 보고 싶어 한다. 체인지 로그를 사내 개발자끼리만 본다면 한 일만 담백하게 적어도 상관없다. 하지만 외부 개발자나 일반 사용자가 보는 체인지 로그를 쓸 때는 개발자 관점이 아니라 고객 관점에서 써야 한다. 고객 관점으로 쓰려면 변경사항이 고객에게 끼치는 영향을 체인지 로그에 추가해서 기술하면 된다. 예를 들어 다음과 같이 개발자가 문제를 해결한 내용만 기술한 체인지 로그가 있다고 하자. 댓글에서 애니메이션 스티커 때문에 화면이 멈추는 문제를 해결했습니다. 이것..
-
개발자의 글쓰기 - 에러 메시지책책책 책을 읽읍시다/프로그래밍 2023. 8. 11. 21:39
에러 메시지의 목적은 사용자에게 에러가 났음을 알려주는 것이 아니라 사용자 스스로 에러를 해결하게 하는 것이다. 따라서 사용자 에러 메시지에는 에러의 내용, 에러의 원인, 에러 해결 방법이 포한돼야 한다. 에러 내용 : 오류로 인한 문제와 종류 에러의 원인 : 오류를 발생시킨 직접적이고 근본적인 원인 에러 해결 방법 : 사용자가 오류를 해결할 가장 쉽고 빠른 방법 회원 가입 중 휴대전화 번호를 01012345678 형식으로 입력해야되는데, 010-1234-5678로 잘못 입력한 경우에 위 규칙을 적용해보자. [에러 내용] 회원가입을 진행할 수 없습니다. [에러 원인] 휴대전화 번호를 잘못 입력하셨습니다. [에러 해결 방법] 휴대전화 번호 입력란에는 숫자만 입력하십시오. 에러 메시지를 보여주는 순서 에러 ..
-
개발자의 글쓰기 - 문장과 단락을 구조화하는 법책책책 책을 읽읍시다/프로그래밍 2023. 8. 8. 23:44
저자 : 김철수 들어가며 개발자로서 직업인으로서 갖추어야 할 글쓰기 방법에 대해 쉽게 알려주는 책이다. 토비의 스프링같이 완독 자체로도 의미있는 그런 난이도 있는 책을 읽고 난 뒤 머리를 식힐겸 읽어도 좋을 책이다. 신입때 이전 직장에 있을 때는 개발자가 코드만 잘 짜면 되는줄 알았다. 개발이란 작업을 코드로 구현하는 위주로 접근했던 때이다. 이직을 하고 난 뒤 생각이 바뀌어 개발에 대해 다시 고민하기 시작했고, PO, 디자이너, 동료 개발자, QA 등 제품과 관련된 모든 이해관계자와의 소통, 업무 지식 문서화와 같은 소프트 스킬이 개발의 반을 이룬다는 것을 깨달았다. 소프트 스킬이 부족하면 업무 성과가 나올수가 없다. 이번 책은 소프트 스킬 중 문서를 잘 작성하기 위한 기술적인 가이드를 해준다. 변수 ..