You are looking for information, articles, knowledge about the topic nail salons open on sunday near me 문서 버전 관리 on Google, you do not find the information you need! Here are the best content compiled and compiled by the Toplist.maxfit.vn team, along with other related topics such as: 문서 버전 관리 문서 버전 관리 규칙, 문서 버전 표기법, 문서 버전 관리 프로그램, 문서 이력 관리, 워드 문서 버전 관리, 문서정리 wiki, GitHub 문서 관리, 엑셀 버전관리
효율적인 문서 버전 관리 – Dropbox
- Article author: experience.dropbox.com
- Reviews from users: 18961
Ratings - Top rated: 4.5
- Lowest rated: 1
- Summary of article content: Articles about 효율적인 문서 버전 관리 – Dropbox 버전 관리란 시간이 지남에 따라 생기는 다양한 파일 버전을 관리하는 프로세스로, 버전 관리 체계는 원래 소프트웨어 구축 시 코딩 변경 사항을 관리하기 위해 개발 … …
- Most searched keywords: Whether you are looking for 효율적인 문서 버전 관리 – Dropbox 버전 관리란 시간이 지남에 따라 생기는 다양한 파일 버전을 관리하는 프로세스로, 버전 관리 체계는 원래 소프트웨어 구축 시 코딩 변경 사항을 관리하기 위해 개발 … 문서의 변경 사항을 추적하고, 언제나 최신 버전의 문서에 액세스하세요. 문서 버전 관리에 대해 자세히 알아보세요.
- Table of Contents:
버전 관리란
팀에 버전 관리가 필요한 이유 5가지
버전 관리를 통한 문서 관리 체계 구축
Dropbox 시작하기
언어 선택
Github 으로 텍스트 문서 버전 관리하기 | LOVIT x DATA SCIENCE
- Article author: lovit.github.io
- Reviews from users: 23173 Ratings
- Top rated: 4.3
- Lowest rated: 1
- Summary of article content: Articles about Github 으로 텍스트 문서 버전 관리하기 | LOVIT x DATA SCIENCE 여하튼 Word 를 이용하여 문서 버전을 관리하다보니 아래처럼 파일로 버전 관리를 하게 되었습니다. 사실 이 스크린샷에서도 알 수 있는 단점은, 각 버전 … …
- Most searched keywords: Whether you are looking for Github 으로 텍스트 문서 버전 관리하기 | LOVIT x DATA SCIENCE 여하튼 Word 를 이용하여 문서 버전을 관리하다보니 아래처럼 파일로 버전 관리를 하게 되었습니다. 사실 이 스크린샷에서도 알 수 있는 단점은, 각 버전 … analytics,이전에 글을 쓸 때 첨삭의 편의 때문에 Word 를 이용했습니다. 그런데 여러 명이 함께 글을 작업하다보니 버전이 꼬이는 문제가 발생했습니다. 그 때 부터 문서에 대한 버전 관리의 필요를 느끼게 되었고, 최근에 github 을 이용하여 문서 버전 관리를 하기 시작했습니다. 그 과정에서 배운 점들을 정리합니다. 조금 더 효율적인 문서의 버전 관리를 할 수 있기를 바라며 글을 공유합니다.analytics
- Table of Contents:
사건의 발단 Word 에서 github 으로
Github 으로 문서 버전을 관리하기 위한 팁들
Conclusion
#2 디자인 문서 버전 관리
- Article author: velog.io
- Reviews from users: 11614 Ratings
- Top rated: 4.1
- Lowest rated: 1
- Summary of article content: Articles about #2 디자인 문서 버전 관리 2 디자인 문서 버전 관리. … 전회사 디자이너는 버전 표시를 따로 하지 않았기 때문에 필요성이나 이해도가 없었는데, 이직한 회사에서는 버전 표시 … …
- Most searched keywords: Whether you are looking for #2 디자인 문서 버전 관리 2 디자인 문서 버전 관리. … 전회사 디자이너는 버전 표시를 따로 하지 않았기 때문에 필요성이나 이해도가 없었는데, 이직한 회사에서는 버전 표시 … #2 디자인 문서 버전 관리
- Table of Contents:
ìì¤ì½ëì²ë¼ 문ì ê´ë¦¬í기 | ìí ë¸ë¡ê·¸
- Article author: www.whatap.io
- Reviews from users: 21639 Ratings
- Top rated: 4.1
- Lowest rated: 1
- Summary of article content: Articles about ìì¤ì½ëì²ë¼ 문ì ê´ë¦¬í기 | ìí ë¸ë¡ê·¸ Ascioc을 사용해 코드를 관리하는 방식과 동일하게 문서를 업데이트하고 배포 … 이슈 추적; 버전 관리; 텍스트 기반; 코드 리뷰; 자동화된 테스팅. …
- Most searched keywords: Whether you are looking for ìì¤ì½ëì²ë¼ 문ì ê´ë¦¬í기 | ìí ë¸ë¡ê·¸ Ascioc을 사용해 코드를 관리하는 방식과 동일하게 문서를 업데이트하고 배포 … 이슈 추적; 버전 관리; 텍스트 기반; 코드 리뷰; 자동화된 테스팅. Asciidocì ì¬ì©í´ ì½ë를 ê´ë¦¬íë ë°©ìê³¼ ëì¼íê² ë¬¸ì를 ì ë°ì´í¸íê³ ë°°í¬í ì ììµëë¤.Docs as Code, One source multi use, asciidoc, jenkins, ì í¨ì¤, 문ì, ê´ë¦¬
- Table of Contents:
목록 또는 라이브러리의 버전 관리 설정 및 구성
- Article author: support.microsoft.com
- Reviews from users: 8534 Ratings
- Top rated: 3.6
- Lowest rated: 1
- Summary of article content: Articles about 목록 또는 라이브러리의 버전 관리 설정 및 구성 문서를 편집하기 전에 문서를 검사해야 합니다. SharePoint Online의 라이브러리 설정 옵션, 사용 가능한 버전 표시. 목록의 경우: 제출된 항목에 대한 콘텐츠 승인 … …
- Most searched keywords: Whether you are looking for 목록 또는 라이브러리의 버전 관리 설정 및 구성 문서를 편집하기 전에 문서를 검사해야 합니다. SharePoint Online의 라이브러리 설정 옵션, 사용 가능한 버전 표시. 목록의 경우: 제출된 항목에 대한 콘텐츠 승인 … 목록 및 라이브러리에서 버전 관리를 사용하도록 설정하여 정보가 발전함에 따라 정보를 추적하고 관리하는 방법을 알아보습니다. 이전 버전을 보고 복구하고 주 버전과 부 버전의 파일을 모두 추적합니다.
- Table of Contents:
목록 또는 라이브러리에서 버전 관리 사용 및 구성
목록 또는 라이브러리에서 이전 버전을 보거나 복원하거나 삭제하려면
SharePoint 2016 또는 SharePoint 2013 목록 또는 라이브러리에서 버전 관리 사용 및 구성
SharePoint 2016 또는 2013 목록 또는 라이브러리에서 버전 설정을 사용하지 않도록 설정하는 경우
이전 버전을 보거나 복원하거나 삭제하려면
SharePoint 2010 목록 또는 라이브러리에서 버전 관리 사용 및 구성
SharePoint 2010 목록 또는 라이브러리에서 버전 해제
SharePoint 2010 목록 또는 라이브러리에서 버전 보기 복원 또는 삭제
버전에 영향을 주는 기타 설정
이 정보가 유용한가요
의견 주셔서 감사합니다!
문ì ë²ì ê´ë¦¬
- Article author: oip.manual.canon
- Reviews from users: 11281 Ratings
- Top rated: 3.6
- Lowest rated: 1
- Summary of article content: Articles about 문ì ë²ì ê´ë¦¬ 문서 버전 관리. 1ESC-0CW. 이 섹션에서는 문서 버전을 관리하는 방법에 대해 설명합니다. 버전 정보 관리 · 버전 기록 표시 · 이전 버전 복원 · 이전 버전 문서 저장. …
- Most searched keywords: Whether you are looking for 문ì ë²ì ê´ë¦¬ 문서 버전 관리. 1ESC-0CW. 이 섹션에서는 문서 버전을 관리하는 방법에 대해 설명합니다. 버전 정보 관리 · 버전 기록 표시 · 이전 버전 복원 · 이전 버전 문서 저장.
- Table of Contents:
Git처럼 버전관리 되는 에디터나 문서작성기가 있나요?
- Article author: m.todaysppc.com
- Reviews from users: 11347 Ratings
- Top rated: 4.3
- Lowest rated: 1
- Summary of article content: Articles about Git처럼 버전관리 되는 에디터나 문서작성기가 있나요? 웹으로 버전 관리되는 문서 작성기 원하시면 위키가 딱 좋죠. 개인적으로 레드마인 깔아서 개인 프로젝트 관리하고 노트 작성하고 있습니다. 추천:NullStr … …
- Most searched keywords: Whether you are looking for Git처럼 버전관리 되는 에디터나 문서작성기가 있나요? 웹으로 버전 관리되는 문서 작성기 원하시면 위키가 딱 좋죠. 개인적으로 레드마인 깔아서 개인 프로젝트 관리하고 노트 작성하고 있습니다. 추천:NullStr …
- Table of Contents:
See more articles in the same category here: toplist.maxfit.vn/blog.
Github 으로 텍스트 문서 버전 관리하기
이전에 글을 쓸 때 첨삭의 편의 때문에 Word 를 이용했습니다. 그런데 여러 명이 함께 글을 작업하다보니 버전이 꼬이는 문제가 발생했습니다. 그 때 부터 문서에 대한 버전 관리의 필요를 느끼게 되었고, 최근에 github 을 이용하여 문서 버전 관리를 하기 시작했습니다. 그 과정에서 배운 점들을 정리합니다. 조금 더 효율적인 문서의 버전 관리를 할 수 있기를 바라며 글을 공유합니다.
사건의 발단, Word 에서 github 으로
동료와 함께 글 하나를 쓰는 중이었습니다. 이전에는 글을 쓸 때 첨삭이 편하다는 이유로 Word 를 이용했습니다. 이제와 생각해 보니 물론 Microsoft Word 의 comment 기능이 편리하기는 합니다만, 유일하게 그 기능을 제공하는 툴도 아닙니다. 쓰던 것이 편하다는 일종의 레거시라고 생각됩니다. 다른 툴을 고민하지 않고서 여전히 Word 를 쓰던 것이었으니까요.
여하튼 Word 를 이용하여 문서 버전을 관리하다보니 아래처럼 파일로 버전 관리를 하게 되었습니다. 사실 이 스크린샷에서도 알 수 있는 단점은, 각 버전마다 무엇이 크게 바뀌었는지 문서를 열어보기 전에는 알 수가 없다는 점입니다. 적어도 파일명에 큰 변화는 알 수 있게 메모를 하거나, 버전 별 readme 라도 만들어 뒀어야 했습니다. 일단 이 점이 잘못된 점이었습니다.
물론 워드로도 충분히 첨삭되는 부분을 잘 추적하며 관리할 수 있지만, 문제는 두 명이 동시에 문서를 건드리기 시작하면서 발생했습니다. 사본 충돌의 가능성이 있기 때문에 파일을 두 개로 복사하여 나눠 작업을 시작하였습니다. 완료가 되는대로 한 명이 수정된 내용을 반영하기로 했습니다. 그리고는 수정된 내용을 반영해야 했던 저는 그 일을 잊어버렸습니다. 한 부분의 수정이 반영되지 않은 체 일은 계속 진행되었습니다.
다른 문제도 생겼습니다. 동 버전의 여러 파일에 나눠서 서로가 조금씩 내용을 바꿨습니다. Word 파일로 작업을 할 때에는 수정할 범위를 명시하고 그 부분에 대해서만 수정해야 하는데, 그런 생각도 하지 않았습니다. 결국 최종본에는 애써 고쳤던 내용들이 군대군대 빠져있는 일이 생겼습니다. 앞서 말한 것처럼 일이라도 몰아서 한 번에 끝내는 성격이면 무엇인가 놓쳤다는 사실을 빨리 깨달았을텐데 그것도 아니어서, 엄두가 안났습니다. 문서 두 개 펼쳐두고 틀린 부분 찾자니 그것도 싫었고, 그걸 위해 두 문서의 틀린 부분을 트래킹 할 수 있는 코드를 짜자니 자괴감이 들었습니다.
“일을 몰아서 했었더라면” 이란 생각도 잘못된 생각입니다. 애초에 이런 문제가 발생하지 않도록 잘 준비를 했었어야 했습니다. 다른 이슈도 있었습니다. 예전에 논문 첨삭 받았던 첨삭본을 잃어버린 적도 있었습니다. 종이에 팬으로 기록한 정보는 물리적으로 잃어버리기 쉽습니다.
그 때 부터 어떤 방법이 좋을까 고민했습니다. 코드도 버전을 관리하는데, 문서 역시 버전을 관리 해야겠다는 생각을 했고, 그런 툴을 찾아봤습니다.
이전에 들었던 이야기가 생각났습니다. 어떤 연구실의 교수님은 학생들의 논문 리뷰를 github 으로 해주신다는 이야기를 들었었는데, 생각해보니 이점이 많아 보였습니다. github 은 difference 에 대해서 tracking 을 할 수 있고, 수정된 부분마다 commit 을 하면 어떤 부분이 수정된 것인지, 그리고 그 때의 버전으로 문서를 볼 수도 있으니까요. 저도 git 으로 문서 버전을 관리하는 연습을 해보기로 했습니다.
기대하는 효과는 1) 문서의 수정 사항들을 관리할 수 있고, 2) 각 버전마다 문서를 복원할 수 있으며, 3) 인쇄본을 잃어버린다던지 실수로 폴더를 지워 문서를 잃어버리는 일을 방지할 수 있다는 점입니다.
Github 으로 문서 버전을 관리하기 위한 팁들
일단, 수정을 해야 하는 latex 파일이 하나 있었습니다. 이 파일을 수정하면서 git 으로 latex 를 관리하는 연습을 해보기로 했습니다.
수정의 내용 (주제) 단위로 commit 하기
원칙은 코드 관리와 동일합니다. 수정하는 내용 단위로 commit 을 넣습니다. 그 내용이 문서의 중간과 끝부분에 나뉘어져 있다 하더라도 내용 단위로 commit 을 남기면, 무엇을 수정했는지 이후에 묶어서 볼 수가 있습니다.
아래 그림은 예시 latex 코드에서 가독을 위하여 section 마다 넣어두었던 주석줄의 길이를 일괄적으로 줄이는 부분입니다. 문서의 위치 단위가 아니라 의미 단위로 수정을 하면 이후에 관리도 쉽습니다.
또한 commit 을 누르면 해당 commit 에 대한 comments 를 달 수 있습니다. 메모를 남기고, 함께 작업하는 사람과 간단한 토론을 할 수도 있습니다.
Branch 로 큰 주제 관리하기
큰 글의 경우에는, 혹은 여러 개의 단편적인 글들을 한 번에 작업할 때에는 branch 를 나눠 관리할 수도 있습니다. Branch 를 나누면 큰 주제에 대한 commit 만을 보며 관리할 수 있으니까요. 수정된 최종 버전은 master 에 merge 하면 됩니다.
Issue board 를 이용하여 todo list 관리하기
이후로 해야 할 일들은 issue board 를 이용하기로 했습니다. 여러 명이서 작업하는 문서라면 누군가에게 할 일을 할당할 수도 있습니다. 일이 완료되면 해당 issue 를 closed 하면 됩니다.
포스트잇에 todo list 를 적고 줄을 긋는 것 보다 훨씬 현명한 방법이라 생각됩니다. Issue boards 의 숫자를 보며 스스로 압박도 받는다는 장점(?)도 있고요.
한 문장을 한 줄로 적기
Latex 을 쓸 때 한 단락을 한 줄로 적는 경우가 많습니다. 그런데 git 은 줄 단위로 코드를 관리합니다. 열 문장으로 이뤄진 한 단락을 한 줄에 모두 적으면 한 줄만 바꿔도 단락 전체가 바뀐 것으로 diff 에 표시됩니다.
Latex 은 빈 줄을 기준으로 단락을 나눕니다. 붙어있는 연속된 두 줄은 하나의 단락으로 인식합니다. 그러므로 한 문장을 한 줄로 적는다면, 열 문장으로 이뤄진 단락에서 한 문장을 수정했을 경우, 그 부분만 diff 에 표시됩니다.
PDF 파일은 git 외의 수단으로 공유하기
PDF 는 byte 로 기록됩니다. PDF 안에서 업데이트 되는 내용이 git 으로 추적되지는 않습니다. Commit 을 할 때 마다 각 버전을 모두 지니고 있게 될테니 PDF 는 최종본이나 중간 관리본 외에는 git 으로 관리하지 않기로 하였습니다.
Latex to PDF (compile)
Latex 파일을 local 에서 컴파일해도 좋지만, 몇 번 컴파일 할 일이 없다던지 내용에 대한 수정만 하는 것이라면 online compile service 를 이용하는 것도 편리합니다. Overleaf 는 latex 를 PDF 로 컴파일을 해줍니다. 느리긴 하지만, 패키지 설치나 관리의 수고를 덜 수 있습니다.
Table code generator
Latex 에서 표를 만들 때에는 각 cell 에 대하여 일일히 코딩을 해야 합니다. 혹은 table generator 인 www.tablesgenerator.com 를 이용할 수도 있습니다. 특히나 이 사이트는 csv 파일을 읽어들여 표로 만들 수도 있습니다.
Conclusion
하나의 문서에 대하여 git 으로 문서 버전 관리하는 연습을 해보았는데, 이후로 Word 를 메인으로 쓸 일은 없을 것 같다는 생각이 들었습니다. 쓰던 것들에 대해 판단없이 계속 이용하는 것은 없는지 고민해볼 계기가 되었습니다.
한글 latex 문서의 예시 파일도 github에 올려두었습니다.
Appendix. 한 줄로 씌여진 문단의 문장을 각 줄로 나누기
이전에 작성한 latex 는 한 문단을 한 줄로 적는 경우가 많았습니다. 문단 단의 문장들을 각 줄로 나누는 설거운 코드를 적어뒀습니다. 고칠 부분은 한 줄이 paragraph 인지 확인하는 부분으로 생각됩니다.
한 줄이 문단이면 이를 문장으로 나눠 쓰는게 목표입니다.
list of str 형태의 lines 를 입력받아 paragraph 인 줄을 separate 함수에 넣어 분리합니다.
def _a_sentence_a_line ( lines ): lines_ = [] for line in lines : if not line . strip (): lines_ . append ( line ) elif line [ 0 ] == ‘%’ or line [ 0 ] == ‘ \\ ‘ : lines_ . append ( line ) elif is_paragraph ( line ): lines_ += separate ( line ) else : lines_ . append ( line ) return lines_
is_paragraph 함수는 글자수가 10 보다 크고 두 개 이상의 마침표를 포함하는 줄로 정의하였습니다. 한 문장으로 이뤄진 문단이라면 어자피 그대로 쓰면 되니까요.
def is_paragraph ( line ): return len ( line . strip ()) > 10 and line . count ( ‘.’ ) > 1 def separate ( line ): l_blank = len ( line ) – len ( line . lstrip ()) r_blank = len ( line ) – len ( line . rstrip ()) separateds = line . strip (). split ( ‘.’ ) separateds = [ sep + ( ‘.’ if sep else ” ) for sep in separateds ] separateds = [ sep . strip () for sep in separateds ] separateds [ 0 ] = ‘ ‘ * l_blank + separateds [ 0 ] separateds [ – 1 ] = ‘ ‘ * r_blank + separateds [ – 1 ] return separateds
만든 함수를 테스트 합니다.
s = ‘문장이다. 두번째다. 세번쩨다.
두번째 단락이다. 두번째의 두번째다.’
위 문장은 텍스트 파일에 다음의 형태로 기록되어 있습니다.
문장이다. 두번째다. 세번쩨다. 두번째 단락이다. 두번째의 두번째다.
이를 앞서 정의한 함수에 넣습니다.
lines = s . split ( ‘
‘ ) lines_ = _a_sentence_a_line ( lines )
결과는 아래와 같습니다.
문장이다. 두번째다. 세번쩨다. 두번째 단락이다. 두번째의 두번째다.
load, save 부분만 추가합니다.
소스코드처럼 문서 관리하기
와탭의 모니터링 서비스는 매우 빠른 주기로 수정되고 업데이트 됩니다. 그리고 이 과정에서 관련 정보와 업데이트 내역을 문서로 반영해 배포하는 것은 서비스 제공자로서 필수 입니다.
현황 및 문제점 다수 개발자들은 버그 픽스나 기능 추가를 즐기지만 이런 변경 내역을 문서로 배포하는 것은 부담스러워합니다. 이것은 개발자 뿐 아니라 Pre-sales와 컨설팅을 담당하는 저 역시 마찬가지입니다. 그리고 문서를 작성하는 과정 자체가 번거롭고 불편하다 보니 고객지원이나 개발에 비해 우선순위를 낮게 두는 경향이 있었습니다. 기존에 사용했던 절차 입니다. 기능 추가 또는 버그 수정 홈페이지 블로그에 릴리즈 노트 MS Word에 내용 추가 MS Word 문서를 PDF로 변환해 홈페이지에 개시하거나 고객에게 전달
이력 관리의 부재 “워드로 작성해 공유드라이브에 업로드 했는데 최종 반영이 안되었어요, 알고보니 최신본은 다른 경로에 있었네요.” “이번에 고객이 문의주신 내용을 문서 어디선가 본것 같은데 찾을수가 없네요.”
누락 “작업하고 문서에는 아직 업데이트 안한게 있었던 것 같은데 까먹었네.” “문서 작업은 다음에 몰아서 해야지.”
가독성 문제 문서의 틀을 잘 잡아 놓았음에도 수정될 때마다 폰트, 글자 크기, 정렬이 제각각입니다. 대대적으로 손을 봐 놓으면 며칠 만에 또 틀어집니다.
수정의 문제 “옵션 기본값을 바꿨는데 어디어디 문서에 반영해야할지 모르겠어요. 그리고 언제부터 바꿨다고도 적어놔야 할 것 같은데요.”
원하는 모습 누가, 언제, 왜, 무슨 내용을 바꾸었는지를 알고 싶었습니다. 누굴 못 믿어서 가 아니라 매번 담당자 찾아가서 물어보는데 시간이 너무 걸렸습니다. 소스코드는 git commit 이력을 보면 쉽게 알 수 있었지만 문서는 그렇지 못했습니다. 최신본을 찾기 위해 공유 드라이브를 찾아 헤매고, pdf로 변환해서 홈페이지에 업로드하고, 고객에게 첨부해 전달하고 하는 등의 소모적인 작업들을 줄여보고 싶었습니다. 사실 콘텐츠를 작성하는 일 보다 이런 부수적인 일들에 더 많은 시간이 소요되었기에 꼭 바꿔보고 싶었습니다. 문서에 반영하는 과정이 번거롭다 보니 몰아서 하려 하고 이 와중에 타이밍을 놓치게 되면 한참이 지난 뒤에야 문서로 반영이 되거나 심지어는 누락이 됩니다. 사실 최신본일까 못 미더운 각각의 워드 파일을 열어 고치고 다시 날짜를 바꿔 저장해서 업로드하는 과정 역시 너무 소모적이었습니다.
문제 해결의 실마리 : Docs as Code 소스코드를 관리하듯 문서를 관리하자는 개념으로 Docs as Code가 있습니다. 이것이 포함하는 바는 다음과 같습니다. 이슈 추적
버전 관리
텍스트 기반
코드 리뷰
자동화된 테스팅 문서화에서 발생하는 문제점을 해결하기 위해 Docs as Code라는 개념이 있는 것을 알았습니다. 이것으로 한줄기 빛을 보았습니다만 와탭이 필요로 하는 고객에게 제공될 ‘릴리즈 노트’, ‘서비스 가이드’와 같은 문서에 적용할 사례를 찾기는 힘들었습니다. 저희가 원하는 바는 Docs as Code의 정의와 약간의 차이가 있지만 그래도 필요로 하는 기능들을 조합하면 충분히 구현할 수 있겠다는 생각이 들었습니다. 최종적으로는 다음 내용들을 적용하기로 마음 먹었습니다. 공동 작업
버전 관리
텍스트 기반
OSMU(One source multi-use)
CI(Continuous Integration)
적용 과정
도구 선택 코드를 작성하는것과 같이 문서를 작성하기 위해서는 WYSIWYG이 아닌 텍스트기반 편집도구가 필요했습니다. WIKI도 있고 MarkDown도 있지만 다음과 같은 이유로 Asciidoctor를 선택 했습니다. MarkDown 보다 다양한 문법들이 있다. Git과 같은 저장소를 사용할 수 있어 공동작업이 가능하다. 결과물을 HTML, PDF와 같이 다양한 형태로 변환할 수 있다. 결과물의 theme를 편집해 원하는 형태로 출력물 디자인이 가능하다. 문서 내에서 다른 문서를 불러올 수 있는 include 태그를 지원한다. maven, gradle 등을 사용해 빌드할 수 있는 플러그인을 제공한다.
문서 변환 가장 많은 시간을 들인 부분은 기존 워드문서를 Asciidoctor 문서로 변환하는 과정이었습니다. pandoc을 사용해 1차 변환했지만 표, 이미지와 같이 어쩔 수 없이 사람 손을 거쳐야 하는 부분들이 생길 수밖에 없었습니다. 여러 가지를 방법을 테스트해 봤지만 사실상 완벽한 자동 변환은 어렵다는 것을 인지하고 문법에 익숙해질 겸 사용 가이드를 참고해 기존 문서들을 대대적으로 변환했습니다.
https://pandoc.org/
https://asciidoctor.org/docs/user-manual/
저장소 구성 및 환경 설정 Text 기반인 Asciidoctor를 선택하니 형상관리가 매우 단순해졌습니다. 단순히 Git에 문서용 저장소를 하나 구성하고 변환한 초기 문서를 Commit 했습니다. 이후 작성을 위해 각자 사용 중인 IDE에 preview 플러그인을 설치했습니다. Asciidoctor는 Eclipse, VSCODE, IntelliJ 등 사용 중인 개발 환경에서 Preview를 볼 수 있는 플러그인을 지원하므로 워드로 작성할 때와 같이 별도 애플리케이션을 실행할 필요가 없어졌습니다. https://asciidoctor.org/docs/editing-asciidoc-with-live-preview/
빌드 스크립트 작성 작성한 문서를 html, pdf로 만들기 위한 maven 빌드스크립트를 작성했습니다. 이것으로 배포까지 자동화할 수 있는 환경이 마련되었습니다. Asciidoctor는 Gradle, Maven, 심지어는 ANT로 결과물을 자동 빌드할 수 있는 플러그인이 제공됩니다. https://asciidoctor.org/docs/asciidoctor-gradle-plugin/ https://asciidoctor.org/docs/asciidoctor-maven-plugin/ https://github.com/asciidoctor/asciidoctor-ant
디자인 html, pdf 문서의 외형을 디자인 했습니다. 와탭의 능력있는 디자이너가 훌륭하게 만들어 줬습니다. https://asciidoctor.org/docsproduce-custom-themes-using-asciidoctor-stylesheet-factory/ https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc
배포 자동화 듬직한 젠킨스씨 뭐니뭐니해도 배포하면 Jenkins입니다. 문서를 html, pdf로 빌드 하고, 공유 드라이브에 복사하고, 홈페이지에 배포하는 일련의 작업들은 Jenkins에게 맡겨 두었습니다. Jenkins 빌드 과정에서 사내 공유 드라이브에 업로드하는 일은 rclone을 사용해 쉽게 구현했습니다.
바뀐 모습 Asciidoctor 문법에 적응하는 약간의 수고를 거쳤더니 워드로 작업할때 겪었던 문제점이 사라졌습니다.
일괄 수정 찾고 고치고 Commit 문서가 100개든 1000개든 내용을 찾는 일은 편집기가 대신 해 줍니다. 날짜를 추가하거나 제목을 바꿔 다시 저장할 일도 없습니다.
변경 이력 관리 이제 릴리즈 노트만 보면 제품이 어떻게 변했는지 보입니다. 블로그, 공유드라이브를 넘나들며 작업하지 않아도 되니 문서들은 꾸준히 업데이트 됩니다. 어떤 문서가 추가되고 무엇이 변경되어 언제 배포되었는지는 Jenkins 빌드 이력을 보면 나옵니다. 어떤 내용이 어떻게 변경되었는지는 Git Commit 이력으로 diff 비교할 수 있습니다.
문서 배포 자동화 작성/수정한 문서를 Commit하면 공유드라이브 업로드, 홈페이지 배포와 같은 일련의 과정은 Jenkins가 해줍니다. 고민할 필요 없이 공유 드라이브에 있는 문서가 가장 최근에 빌드된 최신본입니다. 홈페이지도 항상 최근 배포된 최신본입니다.
문서 가독성 문서 템플릿은 전문 디자이너가 만들었습니다. 글 쓰는 사람은 콘텐츠만 고민하면 됩니다. 더이상 문서 외형 때문에 고민하지 않습니다. html로 제공되는 온라인 문서는 css, javascript까지 적용할 수 있어 디자이너분이 네비게이션 바와 반응형 UI까지 적용해 주었습니다. PDF 역시 디자이너 작품입니다. 폰트에 신경 많이 썼습니다. 저에게 정색하며 “이탤릭이라도 한글은 기울이는거 좋지 않아요.”라고 한 수 가르쳐 주시기도 했습니다.
마무리 Docs as Code 개념을 활용해 문서 작성 프로세스를 바꾼 후 불편했던 점을 해소하고 원하는 모습을 이룰 수 있었습니다. 덕분에 와탭 모니터링 서비스를 시작하거나 사용하는 과정에서 고객이 문의주신 내용들은 기존과 비교할 수 없을 정도로 빠르게 문서에 반영되고 있습니다. 와탭 사용 가이드가 그렇게 관리되고 있습니다. 고객들이 [email protected]로 문의주신 궁금점 들은 이전에도 그랬듯이 소중하게 관리하고 있습니다. 그리고 Pre-sales 컨설턴트로서 가장 마음에 드는 점은 고객 질문에 문서를 바로 보완하고 추가해 설명 링크와 함께 답변 드릴수 있다는 것 입니다.
IT 서비스 성능 관리, 와탭으로 시작하세요. 와탭 무료로 시작하기
So you have finished reading the 문서 버전 관리 topic article, if you find this article useful, please share it. Thank you very much. See more: 문서 버전 관리 규칙, 문서 버전 표기법, 문서 버전 관리 프로그램, 문서 이력 관리, 워드 문서 버전 관리, 문서정리 wiki, GitHub 문서 관리, 엑셀 버전관리