Advanced
Modeling an Information Architecture for Content Reuse in Engineering Accreditation Manuals
Modeling an Information Architecture for Content Reuse in Engineering Accreditation Manuals
The Transactions of The Korean Institute of Electrical Engineers. 2014. Jan, 63(1): 150-155
Copyright © 2014, The Korean Institute of Electrical Engineers
  • Received : November 28, 2013
  • Accepted : December 10, 2013
  • Published : January 01, 2014
Download
PDF
e-PUB
PubReader
PPT
Export by style
Article
Author
Metrics
Cited by
TagCloud
About the Authors
흥 서 구
Corresponding Author : Dept. of Computer and Information Engineering, Cheong-Ju Univ., Korea E-mail :hskoo@cju.ac.kr

Abstract
Content is often developed inconsistently in technical authoring environments, as new documents are created and existing documents are revised. The Darwin Information Typing Architecture(DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering technical documentations. The core of most advanced authoring and publishing systems is the concept of content reuse. In this paper, we describe to design and implement an authoring and producing system of different technical documentations for the accreditation programs of Engineering Education using DITA XML. It provide a content reuse method for accomplishing the improvement of content consistency and the speed-up of the production in technical documentations.
Keywords
1. 서 론
(사)한국공학교육인증원(Accreditation Board for Engineering Education of Korea)은 2000년 시범인증 프로그램을 시작하여 2013년 9월 기준 101개 대학에서 604개 공학교육인증 프로그램(이하 인증프로그램)을 운영하고 있다 [1] . 우리 대학도 2007년부터 인증프로그램을 시작하여 현재는 컴퓨터정보공 학(KCC), 전자공학(KEC), 건축학(KABB) 등 9개 프로그램을 운영하고 있다. 우리 대학 공학교육혁신센터에서는 9개 학과의 교수 및 학생을 대상으로 각각의 프로그램 소개자료, 공학인증시스템 사용자매뉴얼, 학생용가이드북 등을 비롯하여 다양한 문서를 제작, 배포하고 있다. 이러한 기술문서(technical document)는 다양한 사용자가 활용하기 때문에 콘텐츠의 정확성, 문서의 사용자 편리성, 그리고 문서의 제작 효율성이 중요한 요소이다.
기술문서들의 주된 저작자는 공학교육혁신센터 직원·조교, 9개 인증프로그램의 PD교수·공학조교가 참여하는 협업 구조를 이루고 있다. 기술문서 제작은 아래한글을 사용하고 있으며, 이 과정에서 다른 사람의 콘텐츠를 활용할 때는 ‘복사 및 붙여넣기’ 기능을 사용한다. 이러한 환경에서 생산된 기술문서에는 콘텐츠의 불일치, 콘텐츠의 부정확, 협업 환경 에서 문서 제작의 비효율 문제점이 나타나고 있다.
본 연구에서는 이러한 문제를 해결하기 위해, 콘텐츠를 모듈형태의 작은 XML(eXtensible Markup Language) 파일들로 저작한 후, 이들을 조립하여 필요한 기술문서를 생산하는 접근방법을 사용하였다. XML은 콘텐츠와 문맥(context) 정보를 분리하여 콘텐츠의 재사용 가능성을 높일 수 있으며, 그래서 동일한 콘텐츠를 여러 기술문서에서 재사용하여 콘텐츠의 일관성을 높일 수 있기 때문이다. 또한 XML-기반의 모듈식 저작방식은 필요한 콘텐츠 조각(content chunk)을 변경한 다음, 해당 콘텐츠 조각을 참조하는 기술문서들을 재생성하는 처리를 하면 변경된 기술문서를 신속하게 생산할 수 있다. 기술문서 제작을 위한 XML-기반 산업계 표준으로 최근 주목받고 있는 주요 기술은 OASIS(Organization for the Advancement of Structured Information Standards) 그룹의 DocBook, DITA(Darwin Information Typing Architecture)가 있다. 이번 연구에서는 2.1절에서 살펴 본 특성들을 고려하여 DITA 표준 [2] 을 사용하였다.
본 연구에서는 XML-기반의 DITA 아키텍처를 사용하여 인증프로그램 관련 기술문서들의 콘텐츠 일관성을 향상시키고 효율적으로 제작할 수 있는 정보 아키텍처를 설계·구현 하였다. 설계된 모델과 적용한 방법은 공학교육인증 관련 기술문서의 품질을 향상시키는데 기여하게 될 것이며, 인증 프로그램을 운영하는 타 교육기관에서 참조 가능한 모델이 될 것이다.
본 논문의 구성은 다음과 같다. 2장에서는 기술문서 제작과 관련된 산업계 표준기술과 콘텐츠 재사용의 종류, 그리고 본 연구에서 사용한 정보 아키텍처 모델링 도구인 IBM Information Architecture WorkBench(이하 IAWB)에 대해 설명하였다. 3장에서는 정보 아키텍처 설계를 위한 사전 단계인 대상 콘텐츠의 분석과, 정보 아키텍처 모델링의 산출물인 DITA 토픽맵(topic map)을 설명하였다. 4장에서는 DITA 맵을 구성하는 토픽들의 구현과 그들을 조립, 변환하여 기술문서의 생성을 설명하고, 5장에서 결론을 맺었다.
2. 관련 연구
- 2.1 산업계 표준기술
제품설명서나 사용자가이드와 같은 기술문서를 효율적으로 제작하기 위한 산업계 표준으로 S1000D, TEI, DocBook, DITA 등이 있으며, 그 중에서 최근 주목받고 있는 기술은 DocBook과 DITA이다. DocBook은 1991년에 O′Relly사와 HAL 컴퓨터시스템사에서 처음 개발되어 1998년 OASIS 그룹에 기증되었으며, 현재 버전 5.0까지 발표되었다. DITA는 1999년에 IBM사에서 내부용으로 개발되어 2004년에 OASIS 그룹에 기증되었다. 현재는 OASIS 그룹에서 관리하고 있으며, 공식표준으로 2005년에 버전 1.0, 2010년에 버전 1.2가 발표되었다.
DocBook과 DITA에 관한 비교 자료로는 관련 프로젝트 수행경험을 가지고 있는 실무자들이 작성한 자료들 [3 , 4 , 5] 이 있다. [3] 은 DocBook과 DITA의 특성 및 장단점을 10가지 측면에서 분석하였고, [4] 는 산업표준 기술로서 XML 스키마 선택시 고려해야 할 평가요소를 네 가지 제시하였다. 콘텐츠 특성, 배포물 유형 및 다양성, 주문제작 정도, 콘텐츠 규모이다. 이 중에서 가장 중요한 요소는 콘텐츠 특성과 배포물의 유형 및 다양성이라고 주장하였다. [5] 는 DockBook 대비 DITA의 장점으로 단순성, 확장성, 맞춤식 콤포넌트 (customizable component), 유효한 참조(validatable references)를 제시하였다. 이번 연구에서는 단순성, 재사용성, 그리고 확장성을 고려하여 DITA 기술을 사용하였다.
- 2.2 콘텐츠 재사용
콘텐츠 재사용이란 동일한 콘텐츠 조각(content chunk)을 한 문서의 서로 다른 위치 또는 여러 문서에서 사용하는 것을 의미하며, 그림 1 은 콘텐츠 재사용 개념도를 나타낸 것이다. 콘텐츠 재사용은 콘텐츠의 일관성뿐만 아니라 기술문서 제작 비용 및 기간을 크게 감소시킬 수 있기 때문에 기술문서 저작 및 출판 시스템의 핵심개념이다. 콘텐츠 재사용 수준은 다음 네 단계로 분류할 수 있다 [6] .
  • ■ 문서 수준 콘텐츠 재사용: 콘텐츠 재사용 단위가 가장 큰 수준으로, DITA에서는 토픽맵(topic map) 단위가 된다. 하나의 토픽맵을 다른 여러 토픽맵에서 참조하여 구현한다.
  • ■ 토픽 수준 콘텐츠 재사용: DITA에서는 독립적인 의미를 가지는 콘텐츠 조각을 토픽이라 한다. 한개 콘텐츠 토픽을 여러 토픽맵에서 참조하여 구현한다.
  • ■ 문단 수준 콘텐츠 재사용: DITA에서는 한 개 토픽 내의 블록 엘리먼트(block element) 단위가 된다. 블록 엘리먼트를 다른 토픽에서 참조하여 구현한다.
  • ■ 구절 수준 콘텐츠 재사용: 콘텐츠 재사용 단위가 가장 작은 수준으로, DITA에서는 한 개 토픽 내의 인라인 엘리먼트(inline element) 단위가 된다. 인라인 엘리먼트를 다른 토픽에서 참조하여 구현한다.
PPT Slide
Lager Image
콘텐츠 재사용 개념도 Fig. 1 Concept diagram of content reuse
재사용 단위는 문서(document) 수준 콘텐츠 재사용, 토픽 (topic) 수준 콘텐츠 재사용, 문단(paragraph) 수준 콘텐츠 재사용, 구절(phrase) 수준 콘텐츠 재사용 순으로 작아진다. 이번 연구의 목적은 XML 기술을 활용한 콘텐츠 재사용 기법을 사용하여 인증프로그램 관련 기술문서들의 제작 시 1장에서 설명한 문제점들을 해결하고자 하는 것이므로, 문서 수준과 토픽 수준 재사용 기법만을 사용하였다. 그 이유는 콘텐츠 재사용 단위가 작을수록 관리의 어려움이 발생할 수 있기 때문이다.
- 2.3 IBM IAWB
IBM Information Architecture WorkBench(이하 IAWB)는 태스크(task)들과 관련 엘리먼트들의 계층구조 형태로 인간활동(human activity)을 모델링하기 위한 이클립스(Eclipse) 기반 소프트웨어 도구이며, 초기 버전의 이름은 Task Modeler였다. 태스크 모델링은 정보 아키텍처, 사용자경험 설계, 교안 설계와 같은 현실세계의 디자인 사례들에 유용한 필수 요소이다. 또한 IAWB는 DITA 모델을 지원하므로, 정보 아키텍트(information architect)들은 IAWB를 사용하여 정보 아키텍처인 DITA 맵을 시각적으로 설계할 수 있다 [7] . 본 연구에서도 IAWB를 사용하여 공학교육인증 관련 콘츠에 대한 정보 아키텍처를 모델링하였다.
3. 정보 아키텍처 모델링
- 3.1 정보 개발 라이프사이클
그림 2 는 정보 개발 라이프사이클을 나타낸 것이며, 본 연구에선 이 라이프사이클에 따라 기술문서를 개발하였다. 3.2절에서는 대상 콘텐츠를 분석하고, 3.3절에선 3.2절의 콘텐츠 분석 산출물을 바탕으로 정보 아키텍처를 설계하였다. 4장에선 3.3절의 정보 아키텍처를 구성하는 DITA 토픽들을 XML로 구현하고, 이 XML 파일들을 조립하여 ‘2013학년도 공학교육인증 사용자가이드(학생용)’ 문서를 생성하였다
PPT Slide
Lager Image
정보 개발 라이프사이클 Fig. 2 Information development life cycle
- 3.2 콘텐츠 분석
콘텐츠 분석은 공학교육인증 관련 콘텐츠 중 9개 프로그램에 대한 ‘2013학년도 공학교육인증 가이드북(학생용)’ 제작을 위한 것으로 한정하였다. 표 1 은 이러한 결과로 생성된 콘텐츠 분류 총괄표의 일부를 나타낸 것이다. 콘텐츠 분류 는 재사용하기 용이하도록 콘텐츠 내용과 콘텐츠 저작 담당자를 기준으로 수행하였다. 표 1 에서 서로 다른 셀에 속한 콘텐츠는 같은 셀에 속한 콘텐츠에 비해 의미적으로 관련성이 낮다.
콘텐츠 분류 총괄표Table 1 Summary table of content classification
PPT Slide
Lager Image
콘텐츠 분류 총괄표 Table 1 Summary table of content classification
- 3.3 토픽맵
정보 아키텍처(information architecture)는 특정 정보를 지원하기 위한 데이터의 계획적인 배치(arrangement)를 의미하며, 정보의 구성요소를 구조화하는 것이다. 따라서 정보 아키텍처는 웹사이트, 마케팅자료, 사용자매뉴얼, 온라인도움말 시스템, 기술보고서 등에 중요한 설계요소이다 [8] .
이번 절에선 3.2절의 표 1 에서 컴퓨터정보공학 프로그램 콘텐츠에 대한 정보 아키텍처를 모델링하였다. 대상 콘텐츠에 대한 정보 아키텍처는 DITA 토픽맵(topic map)을 사용 하여 하향식(top-down)으로 설계하고 설계도구는 IBM IAWB 버전 7.1.6을 사용하였다.
DITA 토픽맵은 콘텐츠 조각인 콘텐츠 토픽(content topic)들을 계층구조로 표현한 정보 아키텍처이다. 토픽맵은 소스 콘텐츠 중에서 의미적으로 관련된 콘텐츠를 그룹화한 논리적 단위이다. 본 연구에서는 표 1 에서 한개 셀에 속한 한개 항목(item) 또는 여러 항목을 하나의 토픽맵으로 설계하였다.
정보 아키텍처는 총 7개의 DITA 토픽맵과 99 개의 토픽으로 모델링하였다. 그림 3 의 (a)는 설계한 DITA 토픽맵들 중 하나인 ′컴퓨터정보공학 맵′을 예로 나타낸 것이며, (b) 는 나머지 6개 맵을 축소해 표현한 것이다. 그림에 나타난 토픽맵을 구성하는 각각의 작은 사각형이 하나의 콘텐츠 토픽이다.
PPT Slide
Lager Image
설계된 토픽맵 Fig. 3 The designed topic maps
7개 토픽맵 중 6개의 토픽맵과 그들을 구성하는 콘텐츠 토픽들은 운영 중인 다른 7개 인증프로그램의 기술문서를 제작할 때 해당 토픽맵 또는 토픽을 참조하여 그대로 재사용할 수 있다. 이러한 방식으로 인해 콘텐츠의 일관성 보장과 제작시간 단축이 가능하다.
4. 구현 및 결과
이번 장에선 토픽맵을 구성하는 토픽들을 구현한 XML 파일과, 이들을 조립하여 목표 문서타입인 PDF와 XHTML 문서로 변환한 컴퓨터정보공학 프로그램을 위한 ‘2013학년도 공학교육인증 가이드북(학생용)’을 설명한다. 7개의 토픽맵을 구성하는 토픽 파일은 99개이며, 편집기를 사용하여 이들을 구현하였다. 콘텐츠 타입은 텍스트와 이미지로 이루어졌 다. 그림 4 는 99개의 토픽 중 하나인 ‘대학 교육목표’ 파일의 일부를 나타낸 것이다. 일반적인 XML 파일이며 DITA 표준을 준수한다. 토픽들은 독립적인 파일로 존재하므로 내용수정이 필요할 때 해당 토픽의 내용만 수정하면 그 토픽을 참조하는 기술문서들의 콘텐츠를 쉽게 변경할 수 있다. 또한 콘텐츠 수정은 해당 토픽을 참조하는 토픽맵에도 전혀 영향을 주지 않기 때문에 작업이 용이하다.
PPT Slide
Lager Image
토픽 파일의 XML 코드 Fig. 4 XML code of a topic file
그림 5 는 7개의 토픽맵과 99개의 토픽을 조립하는 명세서에 해당하는 북맵 파일의 일부를 나타낸 것이다. 이 북맵은 컴퓨터정보공학 프로그램을 위한 ‘2013학년도 공학교육인증 가이드북(학생용)’을 생성하기 위한 XML 파일이다. 이 북맵에선 목표 기술문서의 구조를 고려하여 토픽맵 수준의 재사용과 토픽 수준의 재사용 기법을 사용하였다. 콘텐츠 참조에 의한 재사용 방법을 사용하기 때문에 해당 토픽맵이나 토픽의 내용을 변경해도 영향을 거의 받지 않는다.
PPT Slide
Lager Image
북맵 파일의 XML 코드 Fig. 5 XML code of the bookmap file
북맵을 구현할 때는 소스 콘텐츠에 해당하는 토픽맵의 정보 구조를 그대로 사용해도 되고, 필요한 경우는 토픽맵을 구성하는 토픽들을 직접 참조하여 원하는 구조로 재배열할 수도 있다.
그림 6 그림 7 그림 5 의 북맵 XML 파일을 오픈소스인 DITA-OT(Open Toolkit)를 사용하여 목표 문서타입에 따라 PDF와 XHTML 문서로 변환한 것이다. 그림 6 은 ‘2013학년도 공학교육인증 가이드북(학생용)’을 인쇄할 수 있는 총 72페이지 분량의 PDF 파일의 목차 및 내용을 일부를 나타낸 것이다.
PPT Slide
Lager Image
PDF 문서: 공학인증 가이드북(학생용) Fig. 6 PDF document: engineering accreditation guidebook for student
PPT Slide
Lager Image
HTML 문서: 공학인증 가이드북(학생용) Fig. 7 HTML document: engineering accreditation guidebook for student
그림 7 은 동일한 북맵 파일을 이용하여 생성한 XHTML 파일이며, 이 파일을 관련 홈페이지에 연결하면 온라인용 ‘2013학년도 공학교육인증 가이드북(학생용)’ 문서로 쉽게 이용할 수 있다.
DITA-OT를 사용하여 북맵 XML 파일을 목표 문서타입으로 변환하는 과정은 파이프라인(pipeline)과 유사하며, 그 세부적인 처리절차는 Apache 그룹의 자동화된 소프트웨어 빌드 도구인 Ant의 스크립트 파일로 제어한다. 북맵은 목표 파일타입에 따라 서로 다른 처리절차를 거쳐 PDF나 XHTML 파일로 변환된다. PDF 파일 처리단계에서는 북맵에서 참조된 토픽맵과 토픽들을 조립하여 커다란 XML 파일을 생성한 다음, XSL-FO(XSL Formatting Object) 파일로 변환하고, FO 파일을 최종적으로 PDF 파일로 변환한다.
4. 결 론
본 연구에서는 인증프로그램 관련한 기술문서들을 제작하는 과정에서 나타날 수 있는 콘텐츠 불일치, 콘텐츠 부정확, 문서제작의 비효율 문제점을 개선할 수 있도록 DITA 표준 기술을 사용하여 인증프로그램 콘텐츠에 대한 정보 아키텍처를 설계하였다. 또한 이 정보 아키텍처를 구성하는 토픽들을 XML로 구현하였다. 그런 다음, ‘공학인증 가이드북(학생용)’에 대한 DITA 북맵(XML 파일)을 DITA-OT를 사용하여 PDF 문서와 HTML 문서로 변환 및 생성하여 싱글소스 출판(single-source publishing)의 효율성을 제시하였다.
기본적 접근방법으로 기술문서 제작을 위해 정보를 작은 콘텐츠 조각으로 분할하여 저작한 다음, 이들을 조립하여 필요한 기술문서를 제작하는 방식을 사용하였다. 이러한 싱글 소스 출판 기법은 다양한 기술문서의 품질과 제작 효율성을 향상시킬 수 있을 것이다. 기술문서의 품질은 잘못된 콘텐츠 제공시 발생할 수 있는 분쟁 가능성과, 콘텐츠에 대한 사용자 이해도에 영향을 주는 중요한 요소이다. 제작 효율성 향상은 기술문서의 제작시간 단축과 비용 절감 요구를 해결할 수 있는 방법이 될 수 있다. 본 연구에서는 포함하지 않았지만 기술문서 출판 단계에서 스타일시트 기술을 일관되게 적용하면 문서의 가독성을 향상시킬 수 있을 것이다.
콘텐츠 재사용 기법을 사용하여 기술문서 제작을 위해 DITA 표준기술의 적용은 타당하였고, DITA-OT도 XML 문서의 변환에 필요한 기능들을 충분히 제공하고 있다. 정보 아키텍처 설계와 콘텐츠 토픽 구현할 때 각각 무료 SW인 IBM의 IAWB와 일반 편집기를 사용하였다. 대학이나 소규모 기관 같이 비용적 제약이 있는 경우는 무료 SW사용이 적절한 방법이 될 수 있을 것이다. 그러나 저작해야 할 대상 콘텐츠의 양이 많은 경우는 콘텐츠 토픽의 저작을 시각적으로 지원하는 고가의 상용 도구들(FrameMaker, XMetaL, oXygen XML 등)을 활용하는 방법이 작업 생산성을 향상시킬 수 있을 것이다.
Acknowledgements
이 논문은 2012~2013학년도에 청주대학교 산업과학연구소가 지원한 학술연구조성비(특별연구과제)에 의해 연구되었음.
BIO
구 흥 서 (具 興 書) 1985년 2월 인하대학교 전산학과졸업, 1989년 2월 인하대학원 전산학 전공, 1993년 8월 인하대학원 전산학 전공, 1984년~1986년 현대전자산업(주) 근무, 1994년 3월~현재 청주대학교 컴퓨터정보공학과 근무 Tel : 043-229-8492 Fax : 043-229-8432 E-mail : hskoo@cju.ac.kr
References
The Present State of Engineering Education Accreditation http://www.abeek.or.kr
2010 Darwin Information Typing Architecture(DITA) version 1.2 OASIS
Mulvihill Teresa 2008 Single-source Documentation Docbook Versus DITA
Hamilton Richard 2008 Choosing an XML Schema: DocBook or DITA?
Armstrong Eric 2008 Modular Docs Part 2: DITA vs. DocBook
Hoffmann Maxwell Trends: Levels of Re-use, Adobe Blog http://blogs.adobe.com/techcomm/ 2013/05/trends-levels-of-re-use.html
Abel Scott 2006 IBM Task Modeler for DITA maps
Darnall Bill 2008 "Information Architecture for Design Engineers" IEEE Newsletter 52 (10)