用語集の運用

SimpleModeling.orgでは、BoK(Body of Knowledge)を構築・活用する一環として、用語集(Glossary)の運用を自動化しています。

この仕組みにより、記事の執筆者は意識的にリンクを設定することなく、記事内で使われた用語をBoK上の定義に自動的に結びつけることができます。

この機能を今回公開しました。

機能

今後、公開予定の機能も含めて本サイトの用語機能を紹介します。

記事内の用語への展開

記事中の所出用語に対して、以下の機能が自動的に適用されます。

  • 用語集へのリンクの挿入

  • title属性によるツールチップ情報の付与

  • 用語直後への括弧付き補足情報の挿入 (予定)

  • 記事末尾への用語リストと定義の自動展開 (予定)

用語ページからの記事リンク

各用語のページでは、該当用語を使用しているすべての記事へのリンクが表示されます。(予定)

表示スタイル

本文中の用語リンクは、以下のようなスタイルを採用しています。

  • 平常時は黒字・太字で、本文に溶け込む控えめな見た目

  • マウスホバー時に赤字・ポインター変化でリンクであることを視覚的に提示

これにより、全用語にリンクが付与されていても視覚的な煩雑さを避けつつ、ナビゲーション性を確保しています。

履歴

サイトのトップ・ページや各カテゴリのトップページには新着記事のバナーが表示されるようになっています。

このバナーに用語の追加を表示するのはちょっと過剰な感じなので、用語の追加や記事の更新などの情報を履歴として表示するページを作りました。

モデルとしての用語集

技術文書において、用語の定義は非常に重要です。

専門分野や読者の知識背景によって用語の意味が変わることが多く、誤解を防ぐためにも、可能な限り用語の意味を明示すべきです。

しかし、毎回手動で定義するのは煩雑で、日常的な技術資料では現実的ではありません。

SmartDoxによる支援

SimpleModelingでは、文芸モデル (literate model)を支えるメタ言語としてSmartDoxを採用しています。

SmartDoxでは用語の自動リンク・補足・一覧出力などの機能が標準でサポートされており、日々の執筆においても負担をかけずにBoKと接続されたドキュメント作成が可能です。

文芸モデリングと用語集

ソフトウェア開発における用語集は、単なる補足情報ではなく、モデル要素そのものです。

SimpleModelingのモデリング・アーキテクチャでは、用語集は概念モデルの一部として位置づけられ、ドメイン・モデルや非エンジニアとの橋渡しを担う中核的要素となっています。

文芸モデリングにおいても、SmartDoxによる用語集機能を活用し、モデルとナラティブの一体化を図ります。