매뉴얼 소개

매뉴얼 구성

본 프로그램의 매뉴얼의 구성은 다음과 같다.

  • 프로그램 소개: 본 프로그램 구조 및 특징을 설명한다.
  • 시작하기: 본 프로그램을 처음 시작하는데 참고할 수 있는 내용을 제공한다.
  • 릴리스 노트: 이전 버전 대비 추가, 변경, 개선 및 버그 수정 등을 설명한다.

용어 정리

본 메뉴얼 에서 사용하는 주요 용어를 정리 하였다….

MiT Migration Toolkit

매뉴얼 규약

다음 표는 매뉴얼에서 ‘문장’, ‘명령어’, 그리고 ‘텍스트 안에서의 참조’를 식별하는데 사용되는 문서 규약이다.

규약 설명 예제
기울임꼴 변수 이름, 예시로 사용하는 값(시스템, 데이터베이스, 테이블 칼럼, 파일 등의 이름)을 나타낸다. persistent : stringVariableName
굵게 상수, 키워드 등 정해진 값을 나타낸다. fetch ( ) member function
고정폭 글꼴 구문, 코드 예제 또는 명령어의 실행 및 결과를 나타낸다. database_name
대문자 키워드를 나타내는 데 사용된다( 굵게 참조). SELECT
작은 따옴표(‘ ‘) 중괄호, 대괄호와 함께 사용되면 문법의 필요한 부분을 나타낸다. 스트링을 감쌀 때도 사용된다. {‘{‘ const_list ‘}’}
대괄호([ ]) 파라미터나 키워드가 선택적임을 나타낸다. [ ONLY ]
세로줄( | ) 여럿 중의 하나만을 선택할 수 있음을 나타낸다. [ COLUMN | ATTRIBUTE ]
중괄호({ })로 싼 파라미터 여럿 중에서 하나만을 반드시 선택해야 함을 나타낸다. CREATE { TABLE | CLASS }
중괄호({ })로 싼 값 집합을 구성하는 원소를 나타낸다. {2, 4, 6}
중괄호 뒤의 줄임표({ }…) 파라미터 지정이 반복될 수 있음을 나타낸다. {, class_name }…
산괄호(< >) 단일 키 또는 일련의 키 입력을 나타낸다. <Ctrl+n>

버전명 및 버전 문자열 규약

본 프로그램의 1.0 이후의 버전명 및 버전 문자열은 다음과 같이 표기한다.