아래와 같은 형식으로 서로의 챕터에 피드백 부탁드립니다.
- 변수는 99% const 1% 정도가 let입니다. (var X)
- 출처(레퍼런스)는 wiki, 책출판과 같이 숫자형태로 연결 ( [1]a -> 출처 [1]a : 00000 )
- 아래 이미지처럼 위첨자로 쓰지 않습니다.
바울랩[1]은 000이다.
- 가능한 출처는 공식문서로만(블로그 X, 책 X)
- 책 개행을 염두하여 작성
- 여러 줄 바꿈 x
- 책이기 때문에 책에 힘들어가기 힘든 문구, 안녕하세요~ 이렇게 물결 표시를 한다던지.
- 개행을 너무 적게하거나 많이 하시면 안됩니다.
- 보고서 형식 x , 줄 글 형식으로 작성
- 오타 체크(한글(hwp) 켜시고, F8 맞춤법 검사기 돌려주세요.)
- 네이버에서 부산대 맞춤법 검사기 검색하시면 아래와 같이 나옵니다.
- 독자의 입장에서 작성 (왜 이걸 알아야 하는지, 알면 좋은 점, 내용의 순서 고려, 이해하기 쉽게 작성)
- 이미지 캡션으로 출처확인(만드는 것이 가장 좋습니다.)
- 코드 작성 시, 코드블럭 JavaScript로 변경 후 작성, 코드 블럭 자동 줄바꿈 체크
- 코드에 대해 의문이 생길 부분들도 함께 정리 (ex, 순서가 바뀌면 어떻게 될까? )
- 예시 좋음 - 예제, 이미지, 코드 사용
- figjam으로 통일, 독자가 보고 이해하기 쉬운 시각적 자료 활용
- 실행할 수 있는 코드로 예제 작성
- 이미지 캡쳐 시 아웃라인을 깔끔하게 없애고 정성껏 캡쳐
- 독자의 눈높이에 맞는 예제 사용 (1.2.2. 비동기식 실행의 예 좋습니다)
- 우리가 읽으면서 이해가 안된다, 우리가 수정할 수 없다 -> 독자도 이해할 수 없는 내용이다
- 개행(공백 2칸)
// 안좋은 예 for(let i = 0; i < 10; i++){ if... //복사를 하실 때 Ctrl + [ 눌러서 들여쓰기 맞춰서 붙여주세요. }
// 좋은 예 Promise // Promise와 같이 메서드 체이닝이 일어나는 경우 아래와 같이 사용합시다. .then() .catch() .finally()
- 이미지 캡션에 넘버링은 없는 것으로
- 주석
// 주석입니다.(O) //주석입니다.(X)
- 결괏값? → o
- 일반적으로 사용자가 궁금해 할 글을 미리 쓰는 것이 좋았다. (돈을 지불해 사용자의 삽질을 해결)
- 이미지 조정 (글자 폰트 크기 맞춰서)
- 무조건 이라는 단어 사용을 신경써서! 문구에 필요할 때만!
- Wikipedia[1]에서는 다음과 같이 설명하고 있다. 이탤릭