매뉴얼에 대하여
문서개요
이 문서는 AsciiDoc 으로 작성하는 매뉴얼에 대하여 설명합니다.
1. 매뉴얼 관리
매뉴얼 관련된 리소스들은 GitLab을 통해서 유지 관리된다. SWD팀에서는 관련 리소스와 매뉴얼탬플릿 그리고 시각화를 위한 Style, CSS 등을 유지 관리한다. R&D에서는 각 제품별, 버전별로 매뉴얼을 작성하고 유지 관리한다. 국제화를 위해서 각 나라의 언어별로 프로젣트를 구분하여 리소스를 관리하는 구조를 갖고 있다.
1.1. 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 | 명명된 모듈 디렉토리: 필요한 만큼 생성 가능하고 생성할 때는 "모듈 디렉토리 명명 규칙"에 준하여 생성한다. |
5 | 이미지 디렉터리 |
6 | 이미지 소스 파일: PNG, JPG, SVG 및 GIF(정적 및 애니메이션) 이미지 파일 형식을 지원한다. |
7 | Pages 디렉토리: 하나 이상의 AsciiDoc 소스 파일이 포함되어야 한다. |
8 | 페이지의 원본 파일: AsciiDoc 구문으로 마크업되고 유효한 .adoc 파일 확장명으로 저장된 페이지 파일 |
9 | 내비게이션 파일 |
10 | ROOT 모듈 디렉토리: ROOT 모듈의 페이지는 구성 요소 버전의 최상위 페이지가 된다. 다른 모듈에서 참조하는 공통 리소스를 저장하도록 한다. |
2. 글쓰기 방법
여러 사람이 집필하지만 한사람이 집필한 것처럼 일관되고 통일된 형태로 문장이 표현될 수 있도록 기존 BGBook 가이드의 글쓰기 방법을 이용하므로 한번씩 정독하도록 한다.
"글쓰기 방법"
3. 매뉴얼 구성
매뉴얼의 기본 구성에 대해서 설명한다.
3.1. 공통 양식
문서를 시작할 때 공통적으로 작성되어야 할 사항이다.
= 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 | 문서 개요 |
3.1.1. 문서 제목
각 페이지마다 하나의 문서 제목을 가진다.
작성 방법은 "문서 제목"을 참고하여 작성한다.