共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

形式ではなく構造を考える

他のパブリッシング・システムに精通している場合は、情報を好きな形式にすることに慣れているはずです。ヘルプタグを用いて設計するときは、形式ではなく構造と内容を考慮することが必要です。

記述するときは、ある種の情報をマークするのにタグを使います。マークする時には情報が何であるかを識別しますが、それをどうフォーマットすべきかは識別しません。

たとえば次のようなマークアップ行を含む本のタイトルを参照するとします。

<book>System Administrator's Reference Guide</book> 

ここでは、構造と内容が形式とは関係ないので、異なるシステムが同じ情報を違う形式で使用できるようになります。たとえば、ヘルプは本のタイトルをイタリックで表示します。しかしシステムによっては、イタリックは使えず、本のタイトルにはアンダーラインが引かれます。