Skip to content

PLATEAU標準製品仕様書のドキュメント改定に用いるMetanormaを活用したモデル駆動型アーキテクチャのプロジェクト一式

License

Notifications You must be signed in to change notification settings

Project-PLATEAU/PLATEAU-Manual-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

モデル駆動型アーキテクチャによる3D都市モデル標準ドキュメントの生成・管理システム

概要

1. 概要

本リポジトリでは、Project PLATEAUの令和6年度の業務の一部であるDT24-01「3D都市モデル標準製品仕様書等の可用性向上」について、その成果物である「モデル駆動型アーキテクチャによる3D都市モデル標準ドキュメントの生成・管理システム」のリソースを公開しています。

「モデル駆動型アーキテクチャによる3D都市モデル標準ドキュメントの生成・管理システム」は、モデル駆動型アーキテクチャを活用し、3D都市モデル標準ドキュメントの生成・管理におけるリソースの一元化と生成の自動化を図るシステムです。

2. 「モデル駆動型アーキテクチャによる3D都市モデル標準ドキュメントの生成・管理システム」について

モデル駆動型アーキテクチャ(MDA)は、ソフトウェア開発手法の一種で、実装方法に依存しないモデルから実装となるプログラムを生成する仕組みです。MDAをドキュメント化のフローに導入することによって、モデリングツール等のソース情報から、具体的な実装となるPDFやHTMLといった各種形式の標準ドキュメントを、自動生成する仕組みを構築します。

具体的にはクラス図画像の出力に利用しているEnterprise Architect(EA)のモデル情報をソース情報(概念モデル)として、フリーのソフトウェアであるShapeChangeとMetanormaを導入することで、製品に付属するurfとuroのXSD(符号化仕様)と、3D都市モデルのドキュメントを生成するフローとなります。

本システムの詳細については、技術検証レポートを参照してください。

3. 利用手順

本システムの構築手順及び利用手順については利用チュートリアル、または下記リソースフォルダに配置したマニュアルを参照してください。

4. システム概要

【概念モデルと符号化仕様の作成】

①EAのプロジェクトファイル変換

  • EAのプロジェクトファイルはeapx形式を利用しているため、ShapeChangeで読み込み可能なqea形式のプロジェクトファイルに、EAの標準機能を用いて出力します。

②ShapeChangeのXSD出力

  • qea形式のプロジェクトファイルから、ShapeChangeでurfとuroのXSDを出力します。

③XSD整形

  • 出力したXSDを、3D都市モデルで利用する形式に整形します(整形プログラムにはVBAを用います)。

【概念モデルとドキュメント作成】

④EAのモデル・ダイアグラム画像出力

  • EAの標準機能を用いて、Metanormaが読み込むXMI(メタデータ情報を交換する標準規格でUMLモデルの交換形式として利用される)と、UMLクラス図の画像ファイルを出力します。

⑤Metanormaによるドキュメント生成

  • Metanormaを利用して、3D都市モデルのスタイルを指定することにより、XMIファイル、UMLクラス図をはじめとした画像ファイル、そしてMetanormaADOC形式(軽量マークアップ言語であるAsciiDocに一部拡張と制限を加えた言語)のadocファイルをコンテンツとして、3D都市モデルの標準製品仕様書と標準作業手順書を自動生成します。

5. 利用技術

種別 名称 バージョン 備考
ミドルウェア Enterprise Architect 16.1 ※ライセンス要
ShapeChange 3.1.0 実体はJARファイルであり、起動させるためにJRE11環境を構築する
Ruby 3.3.6 Metanormaは主としてRubyのGemで構成される(PDF出力にJavaも用いるが、ShapeChangeと同じJRE11で問題ない)
Microsoft Excel - ※ライセンス要

6. 動作環境

項目 最小動作環境 推奨動作環境
OS Microsoft Windows 10 または 11 Microsoft Windows 11
メモリ 16GB以上 同左
CPU Intel Core i7以上 同左
その他    ・利用可能なメモリを20~30G程度を確保しておく
・ShapeChangeはEAと同じマシンにJRE11以上で環境構築する
・インターネットにアクセス可能であり、各ミドルウェアがセキュリティで制限されないようにする
同左

7. 本リポジトリのフォルダ構成

本レポジトリに格納しているリソースフォルダには、下記のサブフォルダがあります(第二階層まで記載します)。なおリソースフォルダ直下には、マニュアルや、GemfileやyamlファイルといったMetanormaで利用するファイル等を配置しています。

フォルダ名  詳細
sources Metanormaのリソースフォルダ
sources\001-v5 標準製品仕様書のコンテンツを格納
sources\002-v5 標準作業手順書のコンテンツを格納
sources\guidance 応用スキーマ文書にカスタマイズを施す場合に利用するyamlファイルを格納(初版リリースでは未利用)
sources\liquid_templates Metanorma出力で利用するliquidファイルを格納
sources\xmi EAから出力した「plateau_all_packages_export.xmi」を格納
ShapeChange-3.1.0 ShapeChange-3.1.0のデフォルトフォルダに、EAのプロジェクトファイル、ShapeChangeのConfig、整形プログラム(ExcelVBA)をそのまま格納
ShapeChange-3.1.0\documentation ShapeChangeのデフォルトサブフォルダ、ShapeChangeのドキュメントが格納されている
ShapeChange-3.1.0\lib ShapeChangeのデフォルトサブフォルダ、ShapeChangeで利用するライブラリファイル(JARファイル)が格納されている
ShapeChange-3.1.0\test テスト出力用フォルダ

8. ライセンス

  • Metanormaを利用するドキュメントコンテンツのソースコード及び関連ドキュメントの著作権は国土交通省に帰属します。
  • 本ドキュメントはProject PLATEAUのサイトポリシー(CCBY4.0及び公共データ利用規約第1.0版)に従い提供されています。

9. 注意事項

  • 本リポジトリは参考資料として提供しているものです。動作保証は行っていません。
  • 本リポジトリについては予告なく変更又は削除をする可能性があります。
  • 本リポジトリの利用により生じた損失及び損害等について、国土交通省はいかなる責任も負わないものとします。

10. 参考資料

About

PLATEAU標準製品仕様書のドキュメント改定に用いるMetanormaを活用したモデル駆動型アーキテクチャのプロジェクト一式

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •