用語集の運用
SimpleModeling (シンプルモデリング).orgでは、BoK (Body of Knowledge)(Body of Knowledge)を構築・活用する一環として、用語集(Glossary (用語集))の運用を自動化しています。
この仕組みにより、記事の執筆者は意識的にリンクを設定することなく、記事内で使われた用語をBoK上の定義に自動的に結びつけることができます。
この機能を今回公開しました。
機能
今後、公開予定の機能も含めて本サイトの用語機能を紹介します。
記事内の用語への展開
記事中の所出用語に対して、以下の機能が自動的に適用されます。
-
用語集へのリンクの挿入
-
title属性によるツールチップ情報の付与
-
用語直後への括弧付き補足情報の挿入 (予定)
-
略語展開(例: CBD (Component-Based Development) → CBD (Component-Based Development))
-
和訳・英訳表記(例: 可用性 → 可用性 (Availability))
-
-
記事末尾への用語リストと定義の自動展開 (予定)
表示スタイル
本文中の用語リンクは、以下のようなスタイルを採用しています。
-
平常時は黒字・太字で、本文に溶け込む控えめな見た目
-
マウスホバー時に赤字・ポインター変化でリンクであることを視覚的に提示
これにより、全用語にリンクが付与されていても視覚的な煩雑さを避けつつ、ナビゲーション性を確保しています。
モデルとしての用語集
技術文書において、用語の定義は非常に重要です。
専門分野や読者の知識背景によって用語の意味が変わることが多く、誤解を防ぐためにも、可能な限り用語の意味を明示すべきです。
しかし、毎回手動で定義するのは煩雑で、日常的な技術資料では現実的ではありません。
SmartDoxによる支援
SimpleModelingでは、文芸モデル (Literate Model)を支えるメタ言語としてSmartDoxを採用しています。
SmartDoxでは用語の自動リンク・補足・一覧出力などの機能が標準でサポートされており、日々の執筆においても負担をかけずにBoKと接続されたドキュメント作成が可能です。
文芸モデリングと用語集
ソフトウェア開発における用語集は、単なる補足情報ではなく、モデル要素そのものです。
SimpleModelingのモデリング・アーキテクチャでは、用語集は概念モデルの一部として位置づけられ、ドメイン・モデル (Domain Model)や非エンジニアとの橋渡しを担う中核的要素となっています。
文芸モデリング (Literate Modeling)においても、SmartDoxによる用語集機能を活用し、モデル (Model)とナラティブ (Narrative)の一体化を図ります。
参照
用語集
- 用語集 (Glossary)
-
Glossaryとは、対象領域で使用する用語について、名称、意味、境界、同義語、識別子を管理する知識資源です。関係者が同じ用語を同じ意味で扱うための共通基盤になります。
- BoK (Body of Knowledge)
-
SimpleModelingでは文脈共有の核となる知識体系をBoK (Body of Knowledge)と呼んでいます。 BoKの構築は、知識の共有、教育、AIによる支援、自動化、意思決定支援を可能にするための基盤です。
- シンプルモデリング (SimpleModeling)
-
SimpleModelingは、KnowledgeからDomain Modelを構成し、CMLで形式化し、CozyとAIによって実行可能ソフトウェアへ実現し、Textus上で動作させる、モデリング中心のソフトウェア開発方法論と技術体系です。
- CBD (Component-Based Development)
-
CBD(コンポーネント指向開発)は、ソフトウェアを責務・契約・インターフェースを明確に定義したコンポーネント単位で構築・再利用する開発方式です。 コンポーネントは独立性と交換可能性を備え、システムを疎結合に構成することで保守性と再利用性を高めます。 論理モデルでは機能や契約を定義する抽象構造単位として、物理モデルでは実際の実装・デプロイメント単位として扱われます。
- 文芸モデル (Literate Model)
-
Undefined
- ドメイン・モデル (Domain Model)
-
Undefined
- ナラティブ (Narrative)
-
Undefined
- モデル (Model)
-
Modelとは、対象を特定のPurposeとConcernに基づいて選択し、理解、判断、検証、構築に利用できる形で表した抽象です。対象そのものではなく、目的に必要な要素、関係、意味を保持する表現です。
- 文芸モデリング (Literate Modeling)
-
Undefined