ISO/TC 211 "자동 문서화(Automated Documentation" 특별그룹(AHG, Ad-hoc group)의 정식 멤버로 활동하게 되었습니다.
ISO 표준문서를 보면, UML 모델과 설명이 상이한 경우가 많습니다. 초안을 만든 뒤, UML을 수정하였으나 설명부분은 수정이 안되는 경우, 등등으로 인해 이러한 오류가 발생합니다. 이 특별그룹은 모든 설명을 UML 등의 모델에 작성하여 자동으로 ISO 표준 문서를 작성함으로써, 이러한 오류를 없애고자 하는 것이 목표입니다.
이 특별그룹 관련 저장소는 : https://github.com/ISO-TC211/AutomatedDocumentation 입니다.
AHG 5 "자동 문서화" 특별 그룹의 두 가지 주요 임무
규정적 선언(Normative statements)
규정적 선언, 적합성 클래스와 시험은 실행 코드가 아닌 순수한 문장으로 쓰여지는 경우가 많다. 이들이 기계가 읽을(machine-readable) 수 있어야 하는지, 가능하다면, 기계가 시험할(machine-testable) 수 있어야 하는지에 대해 의문이 있어왔다. 하지만, 모든 선언이 기계가 시험할 수 있는 것은 아니다. 기계가 읽을 수 있는 선언은 선언에 대해 구조화된 모델이 필요할 것이다. OGC는 자신의 표준을 위해 요구사항 모델을 정의하였다. 이 특별그룹은 <<statement>> 모델 초안을 개발해야 한다. 이 모델은 ISO 19105 모델과 연결되어야 하며, 향후 표준화를 위한 입력으로서 작용해야 한다.
Normative statements, conformance classes and test are often written in pure text, not as executable code. Questions have been raised whether they should be machine-readable and possibly also machine-testable. However, not all statements can be machine-testable. Machine readable statements would require a structured model for statements. OGC has defined a Requirements model for their standards. This ad hoc group shall develop a draft «statements» model. The model shall be linked to the ISO 19105 model and serve as input for future standardization.
모델-기반 문서화(Model-driven Documentation)
어떤 특별 그룹(ref ISO/TC 211 resolution 633)에서는 2013년, ISO TC/211 표준의 모델-파생 문서화에 대해 연구하였다. Enterprise Architect 및 ShapeChange를 위한 템플릿이 개발되었으며, github.com/ISO-TC211/UML-Best-Practices/wiki/DocumentationOfUmlModels 에서 볼 수 있다. 템플릿은 많이 사용되지 않았으며, 아마도 ISO 19135-1에서만 사용되었다. 하지만, ISO 19170-1은 EA로부터, EA => ShapeChange => Metanorma => ISO 문서 로 생성된 바 있다. 이 특별 그룹은 모델-파생 문서화에 대한 접근법 및 ISO/TC 211 표준화 프로젝트에서 활용하는 방법에 대해 연구할 것이다.
An ad hoc group (ref ISO/TC 211 resolution 633) studied model-driven documentation of ISO/TC 211 standards in 2013. Templates for Enterprise Architext and ShapeChange were developed and are available on github.com/ISO-TC211/UML-Best-Practices/wiki/DocumentationOfUmlModels The template has not been much used, probably only by ISO 19135-1. However, the ISO 19170-1 document was generated from EA using: EA => ShapeChange => Metanorma => ISO document. This ad hoc group will study approaches for MDD and how we to facilitate for use in ISO/TC 211 standardization projects.
아래는 Ribose에서 발표한 자료입니다. 확실한 내용은 모르겠지만, Metanorma라는 도구를 사용하면 EA(또는 .xmi)에서 구축한 모델을 docx 파일로 변환이 가능하다는 것 같습니다.
여기에 들어가면 예전(2013)에 문서 자동화를 검토하며 만들어둔 템플릿을 볼 수 있습니다.
아래는 이에 대한 자세한 문서입니다. 시간날 때 정리해보겠습니다.
민, 푸른하늘
댓글을 달아 주세요