= 매뉴얼에 대하여 Heywon Choi <heywon.choi@bankwareglobal.com> include::ROOT:common_attrs.adoc[] [abstract] .문서개요 -- 이 문서는 AsciiDoc 으로 작성하는 {doctitle} 설명합니다. -- == 매뉴얼 관리 매뉴얼 관련된 리소스들은 GitLab을 통해서 유지 관리된다. SWD팀에서는 관련 리소스와 매뉴얼탬플릿 그리고 시각화를 위한 Style, CSS 등을 유지 관리한다. R&D에서는 각 제품별, 버전별로 매뉴얼을 작성하고 유지 관리한다. 국제화를 위해서 각 나라의 언어별로 프로젣트를 구분하여 리소스를 관리하는 구조를 갖고 있다. === Repository 구조 ---- 📒 repository 📂 docs <1> 📄 antora.yml <2> 📂 modules <3> 📂 guide-like-bgbook <4> 📂 images <5> 📄 image-source-file.png <6> 📂 pages <7> 📄 page-source-file.adoc <8> 📄 nav.adoc <9> 📂 ready-to-write <4> 📂 images 📄 image-source-file.png 📂 pages 📄 page-source-fi le.adoc 📄 nav.adoc 📂 ROOT <10> 📂 images 📄 image-source-file.png 📂 pages 📄 page-source-file.adoc 📄 nav.adoc ---- <1> 콘텐츠 원본 루트 <2> 필수 구성 요소 버전 설명자 파일 <3> 필수 모듈 디렉토리 <4> 명명된 모듈 디렉토리: 필요한 만큼 생성 가능하고 생성할 때는 xref:./00aboutManual.adoc#module_name_rule["모듈 디렉토리 명명 규칙"]에 준하여 생성한다. <5> 이미지 디렉터리 <6> 이미지 소스 파일: PNG, JPG, SVG 및 GIF(정적 및 애니메이션) 이미지 파일 형식을 지원한다. <7> Pages 디렉토리: 하나 이상의 AsciiDoc 소스 파일이 포함되어야 한다. <8> 페이지의 원본 파일: AsciiDoc 구문으로 마크업되고 유효한 .adoc 파일 확장명으로 저장된 페이지 파일 <9> 내비게이션 파일 <10> ROOT 모듈 디렉토리: ROOT 모듈의 페이지는 구성 요소 버전의 최상위 페이지가 된다. 다른 모듈에서 참조하는 공통 리소스를 저장하도록 한다. [#module_name_rule] === 모듈 디렉토리 명명 규칙 모듈 이름은 페이지, 이미지, 첨부 파일, 예제 및 부분의 리소스 ID에서 모듈 좌표로 사용된다. 또한 해당 모듈에 할당된 게시 가능한 리소스의 URL에도 사용된다(ROOT 모듈 제외). 따라서 모듈 폴더 이름을 선택할 때 다음 사항을 지켜 생성한다. * 공백이나 슬래시(/)를 포함할 수 없다. * 대문자, 밑줄(_) 및 URL에서 권장되지 않는 기타 문자를 사용하지 않는다. * 너무 길거나 기억하기 어렵게 만들지 말고 짧고 설명적으로 만든다. == 글쓰기 방법 여러 사람이 집필하지만 한사람이 집필한 것처럼 일관되고 통일된 형태로 문장이 표현될 수 있도록 기존 BGBook 가이드의 글쓰기 방법을 이용하므로 한번씩 정독하도록 한다. xref:./00_1writing.adoc#how_to_write["글쓰기 방법"] == 매뉴얼 구성 매뉴얼의 기본 구성에 대해서 설명한다. === 공통 양식 문서를 시작할 때 공통적으로 작성되어야 할 사항이다. [source,asciidoc] ---- = Document Title <1> Gildong Hong <email1@bwg.com> <2> include::../attributes/common_attrs.adoc[] <3> include::../attributes/dir_attrs.adoc[] <3> [abstract] <4> .문서개요 -- 문서에 대해 설명한다. -- ---- <1> 문서 제목 <2> 작성자 정보 <3> 공통 설정 <4> 문서 개요 ==== 문서 제목 각 페이지마다 하나의 문서 제목을 가진다. 작성 방법은 xref:./01title.adoc#document_title["문서 제목"]을 참고하여 작성한다. ==== 작성자 정보 각 페이지마다 작성자 또는 대표 담당자 정보를 문서 제목 아래에 다음과 같은 형태로 기입한다. ---- 성명 <메일주소> ---- ==== 공통 설정 공통적으로 문서에 적용할 속성을 포함시킨다. [source,asciidoc] ---- \include::../attributes/common_attrs.adoc[] \include::../attributes/dir_attrs.adoc[] ---- ==== 문서 개요 문서의 개념 및 작성 과정에 대해서 개략적으로 설명한다. [source,asciidoc] ---- [abstract] .문서개요 -- 이 문서는 AsciiDoc 에서 {doctitle} 을 표현하는 방법에 대해 설명합니다. -- ----