개발자의 글 쓰기

개발자의 글쓰기는 다르다 를 보며 정리하였습니다.

글쓰기는 중요하다.

신입 혹은 다른 팀에서 어떤 정보를 확인할 때 문서를 확인한다. 팀이 비즈니스를 파악할 때 가장 중요한 것 중 하나가 문서이고 이 문서가 관리가 안된다면 서비스에 문제가 생길 수 밖에 없다. 개발자의 역량중 ‘글 쓰기’또한 개발자가 보여줄 수 있는 가치 중 하나라고 생각한다.

개발자의 중요한 것 중 하나는 ‘네이밍’이다. 변수나 함수등의 이름을 정할 때, 어떤 기능을 하는지, 비즈니스 케이스, 다른 사람이 봤을 때 이해가 잘 되게 지어야한다.

SMART

개발자의 글쓰기라는 책에 나온 다섯 가지 기준을 명시하는 좋은 이름을 확인하는 방법이다.

• S Search 검색하기 쉽게
• M Mix 조합하기 쉽게
• A Agree 수긍하기 쉽게
• R Remember 기억하기 쉽게
• T Type 입력하기 쉽게

다른 사람에게 설명하는 기술

글은 자신이 보기 쉽게 적기도 하지만, 다른 사람들이 보는 부분도 중요하다. 정확성, 간결성, 가독성을 생각하며 기술적인 글을 특정 독자에게 정확하고 명확하게 전달하기 위해 프로세스를 잘 사용하는 것 또한 중요하다.