작성 가이드

이 문서는 GitBook 작성 시 참고할 수 있는 문서 작성 가이드이다. Krafton Jungle 9기 구성원 모두가 문서 작성 시 통일된 스타일과 어조를 유지할 수 있도록 돕기 위해 작성되었다.

작성 가이드는 크게 다음 두 가지 항목으로 나뉜다:

1. 서술 가이드

  • 문서를 어떤 문체로 작성할지, 어떤 어휘를 선택할지 등 문장의 흐름과 분위기에 대한 기준을 제시한다.

  • 변수명이나 문서 제목 등에서 사용할 명명법(Naming Convention) 을 규정한다.

2. 마크다운 가이드

  • 사용 예시를 통해 문서의 레이아웃이나 표현 방식을 쉽게 참고할 수 있도록 구성되어 있다.

Last updated