목차
1. 매뉴얼 작성 목적
2. 매뉴얼 본문 작성 기본 포맷
3. Help&Doc을 이용한 포탈 시스템 매뉴얼 작성 및 게시 방법
====================================================================================================
[1] 매뉴얼 작성 목적
* 본 매뉴얼의 최종 목적은 사용자가 매뉴얼을 참조하여 전산팀이나 업무팀의 지원없이 업무담당자가 스스로 업무를 할 수 있도록 하기 위함.
* 지속적으로 기능과 업무 위주의 자세한 설명을 추가하여 업데이트 요망.
[2] 매뉴얼 본문 작성 기본 포맷
DLL-NAME (Tahoma 9pt. normal. 우정렬)
Menu Title (Tahoma 12pt. bold. black. 첫번째 컬럼)
Features (Tahoma 9pt. bold. black. 네번째 컬럼)
메뉴에 대한 전반적인 배경 및 특징 등을 기술한다. (Tahoma 9pt. normal. 7번째 컬럼)
• 필요시 각 설명 앞에 (점•)기호를 사용한다(이하 동일). (Tahoma 9pt. normal, 다른 폰트 사용시 기호가 변형될 수 있으므로 주의한다.)
Menu (Tahoma 9pt. bold. black. 네번째 컬럼)
메뉴 위치 캡쳐하여 붙여 넣고 설명 메뉴의 특징에 대하여 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
How to use Menu (Tahoma 9pt. bold. black. 네번째 컬럼)
메뉴 사용방법이나 업무 process를 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
Menu Screen (Tahoma 9pt. bold. black. 네번째 컬럼)
메뉴 화면을 캡쳐하여 붙여 넣고 메뉴 화면에 대하여 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
Buttons (Tahoma 9pt. bold. black. 네번째 컬럼)
메뉴 상단의 조회, 저장, 삭제 및 화면내의 버튼들에 대하여 설명한다. (Tahoma 9pt. normal. 7번째 컬럼) (Ms-Word 표 그리기 후 붙여 넣음)
Item |
Description |
Type |
|
Inquiry |
buttons |
||
Save |
buttons |
||
Delete |
buttons |
||
Tariff |
buttons |
||
Download |
buttons |
||
Preview |
buttons |
||
Apply |
buttons |
||
FREEDAY |
buttons |
Sub Menu ---> 각 화면에서 우클릭시 나타나는 메뉴 설명
각 메뉴 화면에서 마우스 우클릭시 나타나는 서브 메뉴 화면을 캡쳐하여 붙여 넣고 각 서브 메뉴 항목에 대하여 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
• Sub menu1 (Tahoma 9pt. normal, 다른 폰트 사용시 기호가 변형될 수 있으므로 주의한다.)
서브메뉴1 설명 (Tahoma 9pt. normal. 10번째 컬럼부터 사용)
• Sub menu2 (Tahoma 9pt. normal, 다른 폰트 사용시 기호가 변형될 수 있으므로 주의한다.)
서브메뉴2 설명 (Tahoma 9pt. normal. 10번째 컬럼부터 사용)
...
Controls (Tahoma 9pt. bold. black. 네번째 컬럼)
메뉴 화면내의 각 컨트롤들에 대하여 업무와 연관지어 상세히 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
7번째 컬럼 (Ms-Word 표 그리기 후 붙여 넣음)
Item |
Description |
Type |
|
B/L No. |
B/L number |
text |
|
Cargo Term |
CY/CY, CY/CFS, CFS/CFS, ... |
combo |
|
Freight Term |
FREIGHT PREPAID, FREIGHT COLLECT |
combo |
|
Issued Place |
B/L Issued Place |
combo |
|
T/S |
indicates transhipment cargo |
Check Box |
Grid Columns (grid name) (Tahoma 9pt. bold. black. 네번째 컬럼)
그리드 갯수 만큼 표를 삽입하고 그리드별로 각 컬럼에 대하여 용도, 기능 및 업무와 연관지어 상세히 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
7번째 컬럼 (Ms-Word 표 그리기 후 붙여 넣음)
Item |
Description |
Type |
|
B/L No. |
|||
Cust Cd |
|||
Ex Rate |
Report (Tahoma 9pt. bold. black. 네번째 컬럼)
레포트 프린트 방법 및 필요시 내용에 대하여 간략하게 설명한다. (Tahoma 9pt. normal. 7번째 컬럼)
레포트를 캡쳐하여 붙여 넣는다.
-end-
====================================================================================================
[3] Help&Doc을 이용한 포탈 시스템 매뉴얼 작성 방법
1. 매뉴얼 작성 도구 : HelpNDoc
2. 매뉴얼 폴더 구조 : 업무 메뉴별로 구성
Sinokor Portal System Manual |
|||
Overview |
|||
Installatioin |
|||
Common Usage |
|||
Shipping Management |
|||
Common Menu |
|||
Booking |
|||
Booking |
|||
Booking List View |
|||
Special Cargo |
|||
CANCEL BK B/L Management |
|||
ALLOCATION |
|||
B/K SPLIT COMBINE MANAGEMENT |
|||
Lifting Summary |
|||
Export Documentation |
|||
Import Documenation |
|||
Correction Advice |
|||
Invoice Management |
|||
EDI |
|||
E-SERVICE |
|||
Equipment Management |
|||
Operation Management |
|||
AR & AP Management |
|||
Account Management |
3. 매뉴얼 작성시 본문 첫번째 라인 우측 상단에 DLL 이름 반드시 기재
- 매뉴얼 컴파일 후 각 메뉴 이름으로 생성된 HTML 파일이름을 DLL로 변경하기 위함
4. 매뉴얼 본문 기본 포맷 (비엘 화면 예시)
(본문 첫번째 라인 우측에 DLL 이름을 반드시 기재한다 --->) SHMBLBLMGT B/L Management (메뉴 타이틀 font : Tahoma 12 point, 나머지 본문은 모두 9 point) Features 해당 메뉴 화면의 특징을 자세히 설명한다. Menu 해당 메뉴의 위치를 기재하고 화면을 Capture하여 붙여 넣는다 Menu Screen 메뉴 화면을 Capture하여 붙여 넣고 각각의 기능을 자세히 설명한다. Buttons 각 버턴의 기능을 설명한다. Data Grid Columns 각 Data Grid의 성격/기능을 설명한다. 프린트가 있을 경우 프린트를 설명하고 Capture하여 붙여 넣는다. |
4. HTML 컴파일 후 HTML 파일 이름, HTML 참조 이름 변경
- 매뉴얼 내 각각의 모든 메뉴가 HTML 파일 이름으로 생성된다.
- 전체 메뉴 정보 : toc.html
(1) toc.html 파일을 열어서 메뉴 참조하는 HTML 파일 이름을 모두 변경한다.
예) Booinng.HTML (파일 열어서 우측 상단 DLL 이름 참조) --> SHMBKGBOOKINGMGT.HTML
(2) 각 메뉴 파일을 열어서 HelpNDoc 링크 수정 및 삭제
5. 매뉴얼 게시 방법
TOC.HTML 파일 내의 각 메뉴 HTML 파일명을 DLL 이름으로 변경하고
각 메뉴 HTML 파일도 DLL 이름으로 변경 후에
WEB 서버에 복사하면 끝.
Manual 폴더 위치
서버IP : 192.168.3.10, 192.168.3.11
폴더위치 : D:\inetpub\wwwroot\PortalManual\EN
복사대상 : 폴더 4개 (css, img, js, lib) 및 html 파일 모두.
6. 메뉴 테이블 업데이트 하면 최종적으로 해당 메뉴 타이틀 우측에 help 링크 클릭하여 매뉴얼 참조 가능
또는 관리자 계정으로 포탈에 로그인하여 해당 메뉴의 HTML 컬럼 업데이트하면 됨.
UPDATE SKRPORTAL.SKR_MENU_MST
SET HTMLFILE='COMBOARDLIST.html'
WHERE FORM_ID='COMBOARDLIST'
관리자 계정 로그인 >> System >> Menu Management >> Help File 컬럼에 “DLL이름.html” 입력 후 저장.
끝.