테크니컬라이팅 작성언어, 작성도구 및 문서관리

처음 문서관리를 시작했을 때에는 주로 MS OFFICE 제품들을 사용했다. Word, Ppt, Excel 등으로도 충분히 원하는 문서를 만들고 pdf로 변환하여 관리할 수 있었다.

그러다가 전문적인 언어와 도구를 사용해야겠다고 느낀 이유는 크게 세가지이다.

1. 통일성
2. 문서변환
3. 버전관리

처음 작성도구로 선택한 것은 웹환경에서 문서를 편집할 수 있는 WYSIWYG(What You See Is What You Get)방식의 tistory와 gitbook이였다. 인터넷에 글을 올리는 느낌이라 재미도 있고 편했지만 양식이 너무 제한적이고 공유를 위해서 문서로 변환하는 작업이 마음에 들지 않았다. tistory는 브라우저의 출력기능을 통해서 PDF로 변환했는데 메뉴나 tistory로고가 박혀서 좋지 않았고 gitbook은 PDF변환기능을 사용하기위해서는 유료계정 전환이 필요했다. 또한 PDF뿐만 아니라 Word나 다른 양식으로도 변환할 필요가 있었기 때문에 다른 방법을 찾아보기로 했다.

 

두번째로 찾은 방법은 문서를 소스처럼 작성하는 방식인 마크업언어였다. 그 중 asciidoc언어와 ATOM작성도구를 선택했다. 일단 설치와 구동이 생각보다 많이 까다로웠다. 처음 사용했을때는 멋있는 디자인과 코딩하는 듯한 느낌이 마음에 들었다. 하지만 사용할 수록 ATOM을 통해서 PDF변환이 가능했지만 한글패키지를 추가해도 작성 시 한글이 완벽하게 호환이 되지 않았고 PDF변환도 잘 동작하지 않아서 불편함을 느꼈다. asciidoctor-pdf프로그램을 별도로 설치해서 변환은 가능했지만 이 방식도 역시 한글변환에는 글씨체 등 계속해서 문제가 발생했다. linux환경에서 영문문서를 작성하기에는 아주 좋은 방법이라는 생각이 들었지만 역시나 다른 방법을 찾아보기로 했다.

 

세번째로 선택한 방식이 현재 문서작성 시 사용하고 있는 방식이다.

• 작성언어 : MarkDown
• 작성도구 : Typora
• 관리도구 : Github

지금까지는 위 조합이 아주 완벽한 방식이라는 생각이 든다. 일단 MarkDown언어는 많이 쓰이는 언어이다 보니 자료도 많고 호환도 잘 된다. Typora 역시 어느 웹사이트의 투표결과 윈도우 환경에서 MarkDown언어의 작성도구 중 1위로 뽑힐만큼 디자인도 심플하고 기능도 매우 우수하다. 관리도구 역시 소스관리에 많이 사용하는 Github를 사용했다. (역시 괜히 유명한 걸 쓰는게 아니라는 생각이 들었다.)

 

작업방식은 비교적 간단하다. 작업환경에 프로젝트별로 작업폴더를 생성하고 Typora에서 해당 폴더를 열어서 MarkDown으로 작성한다. 워낙 프로그램을 잘 만들어 놔서 소스코드모드 보다는 WYSIWYG모드를 주로 사용하고 웬만한 양식을 모두 바로바로 작성할 수 있다. 작성이 완료되면 Gitbash를 통해서 작업폴더를 Github에 연동한다.

 

MarkDown으로 작성할 경우 tistory나 gitbook등 웹사이트에서 호환이 가능하여 문서를 양식을 유지하여 그대로 올릴 수 있다. (보여지는 방식이 조금씩 차이는 발생한다.)

Typora는 사용이 매우 편리하고 PDF변환 시 디자인도 몇가지 선택 가능하고 Word나 html, OpenOffice, Latex 등 다양한 형태로 변환도 가능해서 매우 만족스럽게 사용하고 있다.

Github는 이력관리가 되기 때문에 문서의 히스토리를 볼 수 있고 자동으로 문서를 백업하는 효과도 가져갈 수 있다. 소소한 팁으로 문서에 포함되는 이미지를 따로 올려놓고 url을 불러와서 사용할때도 이용한다.

 

이제 몇달간 고민하던 문서작성에 사용할 언어, 도구에 대한 고민은 뒤로하고 문서의 퀄리티를 높이는 방법에만 집중할 수 있을 것 같다.