JIRA Markdown 에디터로 가독성있게 이슈 작성하기

형식보다 내용이 중요하다지만 그건 내용을 신경쓰지 않고 문서 형식만 꾸미지 말라는 의미가 더 크다고 생각합니다.

문서의 단락을 나누고 소스 코드의 언어별 특성에 맞는 신택스 하이라이트를 적용하거나 강조할 부분을 볼드체나 색을 다르게 표시하는 건 작성한 문서의 가독성을 위해 필요합니다.

이런 형식화 작업을 할 때 Jira 에서 제공되는 wysiwyg 에디터를 사용할 수 있는데 형식화가 필요할때마다  상단의 형식화 메뉴를 마우스로 클릭해서 작성하면 문서 작성 흐름이 끊기고 효과적으로 문서 작업을 하기가 어렵습니다.

물론 markdown 에서 제공하는 문법이 다양하므로 다 외워서 사용할 수는 없지만 많이 사용하는 키워드들은 외워서 직접 마크다운 문법을 사용하면 가독성 좋고 읽기 쉬운 문서를 끊김없이 쉽게 작성할 수 있는 장점이 있습니다.

오늘은 이렇게 가독성 좋은 문서를 작성하기 위해 필요한 Jira wysiwyg 에디터 사용법에 대해서 간략하게 설명드리고 많이 사용하는 마크다운 주요 문법에 대해서 설명 드리겠습니다.

Jira 마크다운은 confluence 와 유사하니 Confluence 페이지 작성과 편집기 사용법 을 참고하면 됩니다.