Writing Rules

문서 작성 규칙

본 규칙이 완벽하지는 않습니다! 보완해주시는 것은 언제나 환영입니다. 😄

문서 통합 규칙

1. 초안을 작성합니다.(wiki)
2. 소목차 단위(md파일 1개)의 초안 작성이 완료되면 스스로 리뷰하고 윤문합니다.(wiki)
3. 맞춤법을 검사합니다.
4. 1-3번을 완료하면 소목차 단위(md파일 1개)로 Pull request를 생성합니다.
5. 리뷰합니다.
6. 리뷰하면서 생기는 단어 사용 규칙은 아래 ## 단어 사용 규칙에 추가합니다.
7. 리뷰하면서 글로벌하게 변경이 필요한 부분은 Issue로 남깁니다.
8. 두 번째로 approve하는 리뷰어가 squash and merge합니다.

글쓰기 규칙

• 하다하라체를 사용합니다. (-하다, -하라, -한다)
• 문단의 맨 첫 글자는 띄어 씁니다. (-> 이건 디자인 들어갈때 요구하면 될 것 같습니다. 제 편집기에서는 첫 글짜 띄어쓰기가 안되네요. ㅠ)
• 문장은 간결하게 작성합니다.
• 주어와 술어는 호응해야합니다.
• 주어와 술어를 가깝게 둡니다.
• 수식어는 수식 대상과 가깝게 둡니다.
• 피동보다는 능동형으로 작성합니다.
• '~에 관한', '~에 대한' 은 영어 번역투인 경우가 많습니다. 최대한 사용을 줄입니다.
• '~성', '~적'은 일본식 표현인 경우가 많습니다. 최대한 사용을 줄입니다.
• 이외의 글쓰기 팁은 다음을 참고합니다: 언어학 관점에서의 기술문서 가독성 향상 전략

Heading 규칙

• h1: 대목차 제목
• h2: 소목차 제목
• h3: 소본문을 이루는 항목
• h4: h3의 세부 항목

이미지 삽입 규칙

이미지는 정적으로 삽입합니다.

1. 디렉토리의 하위에 assets 명칭의 새 디렉토리를 생성합니다.
2. 이미지를 assets에 업로드합니다.
3. 마크다운에서 이미지를 불러와 사용합니다.

레퍼런스 규칙

1. 레퍼런스 번호를 정하고 <sup> 태그를 이용하여 본문에 추가합니다.
   ex) 보고서에 따르면⁽¹⁾ 다음과 같다.
2. 문서 제일 하단에 레퍼런스 번호에 해당하는 내용을 추가합니다.
   ex) (1) Nipa OpenUp, 오픈소스 거버넌스가이드 (2021) https://