Dev Books/<개발자의 글쓰기>
깨진 링크(broken link), 죽은 링크(dead link), 나쁜 링크(bad link) : 개발자들이 내버려두는 데에 문제가 있음! 브로큰링크체크닷컴(https://www.brokenlinkcheck.com), 구글 서치콘솔 등으로 깨진 링크 확인 가능 개발자용 에러 메시지, 사용자용 에러 메시지 분리하여 작성하기 사용자 에러 메시지에는 에러 내용, 에러 원인, 에러 해결 방법 함께 표시 재확인 메시지는 행동에 집중하여 유도하는 등 간결하고 명확하게 쓰기 확인/취소 버튼 순서 : 서비스 내 일관성을 갖고 표기하기 남은 로그인 횟수 표시 등을 통해 사용자 반복 에러 막기 '날짜를 잘못 선택하셨습니다. 오늘 이후 날짜를 선택하십시오' 등의 메시지를 통해 사용자 에러 예방 또는 오늘 이전 날짜 선택할..
이름 짓기 : 기존 방식이나 이름을 차용해서 새 이름 짓기, 가독성과 소통이 최우선! "오픈소스의 네이밍 특징들" 자바 네이밍 컨벤션 철저히 준수 네이밍은 보통 16글자, 3단어 조합 주로 명사, 동사, 형용사 조합 네이밍 컨벤션은 기본적으로 영어 표기법 준수 클래스 이름 : 주로 모든 단어 첫 글자를 대문자로 쓰는 파스칼 표기법 (ex. CoffeeMenu) 함수, 변수 이름 : 주로 첫 단어 빼고 나머지 단어 첫 번째 글자만 대문자로 쓰는 카멜 표기법 (ex. totalCount = 0) 상수 : 모두 대문자 표기, 언더스코어(_)로 단어 연결 패키지, 모듈 : 소문자로만 씀 (ex. import developerwriting) BEM 표기법 (Block, Elemenr, Modifier) : 대상-..
문장 구조화하는 법 : 간단한 문장 구조로 핵심만 말한 뒤, 필요에 따라 부가설명하기 서술식 : 설명하거나 논증할 때. 대부분의 개발 가이드 문서 개조식 : 헤드라인이나 어떤 사항 나열할 때. 릴리스 문서나 장애 보고서 도식 : 사물 구조나 관계, 상태를 그림이나 서식으로 나타냄 글을 개조식으로 쓸 때는 글머리 기호 꼭 쓰기! 문서에서 굵기, 모양, 밑줄, 줄 간 거리 등을 통해 계층 나타내기 한글, 비즈니스 문서 등에서.. 책 제목, 신문 이름 등 : 겹낫표 『 』, 겹화살표 ⟪ ⟫, 큰따옴표 " " 소제목, 예술 제목, 상호, 법률, 규정 등 홑낫표 「 」, 홑화살괄호 , 작은 따옴표 ' ' 유사한 영단어 적절하게 선택하기 외래어 표기 : 국립국어원 외래어 표기 용례 확인 http://www.y..
* 개발자 글쓰기의 중요한 특징 : 정확성, 간결성, 가독성 - 정확성 : 틀림 없이 확실한 것. - 간결성 : 글에 군더더기 없이 간단하고 깔끔한 것. 핵심만 기술. - 가독성 : 쉽게 읽히는 것. → 위의 세 가지 원칙은 대치하는 성질을 갖고 있다. → 정확성이 높으면 간결성, 가독성이 낮음. 간결성이 높으면 정확성, 가독성이 낮음. 가독성이 높으면 정확성, 간결성이 낮음. → 체계적으로 배워서 조금만 연습하면 정확하고, 간결하고, 가독성 높은 글을 쓸 수 있다. http://www.yes24.com/Product/Goods/79378905 개발자의 글쓰기 - YES24 오직 개발자를 위한 글쓰기의 모든 것을 담았다!이 책은 개발자의 글쓰기 능력을 종합적으로 향상하기 위한 책이다. 코드 안에서는 함수..
GDSC EWHA 독서 스터디에서 한달 간 읽기를 참여하게 되었다. 한달동안 꾸준히 책을 읽으며 블로그에 간단한 기록을 남기고자 한다. http://www.yes24.com/Product/Goods/79378905 개발자의 글쓰기 - YES24 오직 개발자를 위한 글쓰기의 모든 것을 담았다!이 책은 개발자의 글쓰기 능력을 종합적으로 향상하기 위한 책이다. 코드 안에서는 함수와 변수 이름을 짓는 것부터 주석 쓰는 법, 에러 메시지 www.yes24.com