2024/01/01

新企画:出直し!! ヘルプ

みなさま、あけましておめでとうございます。本年もどうぞよろしくお願いいたします。

今年は就職してちょうど 30 年、そしてノーツを担当して 30 年です。社会人生活をまるっと支えてもらった Notes/Domino にご奉公するべく、さまざまな活動をしております。アニバーサリーイヤーの本年はより積極的に活動しますので、どうぞよろしくお願いいたします。


さて、このブログもその一環で昨年 3 月に始めました。Notes/Domino に関する情報ってネット上に少ないですよね。それを少しでも補完することが目的で始めました。特に初中級の技術者がステップアップのきっかけになるようなネタを中心に進めているつもりです。

実はこのブログにはもう一つ別の動機がありました。それは自身が利用できるヘルプの構築です。


あんちょこ

日々開発作業をしているとよく使う機能があることに気がつきます。その都度、前回使ったであろうアプリケーションDBを思い出し設計を開いてコードを確認するのは非効率です。ライブラリ的なものがあれば便利だなと思っていました。

お客さまの環境、ノーツコンソーシアムの研究会など複数の環境を行き来して、Notes/Domino を利用しています。作成したライブラリをどの環境にいても参照するには、インターネット上のブログが最適だったんですね。

そこで、このブログ上にまとめることにしました。右メニューの[ラベル]から ”あんちょこ” を選択するとその一覧が確認き出ます。

現時点でこのラベルを一番利用しているのは私だと思います(笑)


出直し!! ヘルプ

もう一点、開発していて改善したい点があります。それは、ヘルプです。

Domino Designer にはヘルプがありますが、利用者目線では、次のような点が気になっています。

  • ヘルプが英語(9.0.1 の途中の FP 以降)
  • 情報量が多すぎておぼれる
  • 実用的な例が少ない

もちろん、開発に必要な情報は網羅されてはいるのですが、Notes/Domino の守備範囲が広いため膨大な情報量です。必要なヘルプを探し出すのに慣れが必要で、階層が深く少し時間がかかります。

また、Domino Designer ヘルプはインターネット上で公開されていて、ブラウザの検索機能経由で必要なヘルプを簡単に見つけられます。ただ、日本語で記述された旧バージョンのものや HCLSoftware が公開している各バージョンのヘルプもヒットします。


ないのなら 作ってしまえ! ということで、参照頻度の高いヘルプだけを掲載する『出直し!! ヘルプ:@関数編』を始めることにしました。

記述にあたっては、使用頻度の低い構文や機能、引数などはあえて省いていることがります。すべてを網羅すると情報量が増え、それが雑音となり、わかりにくくさせるからです。すべての機能を正確に知りたい場合には、本家の Domino Designer ヘルプを参照ください。

また、掲載する命令の追加はその命令に関するブログ記事を書いた時を想定しており、不定期な更新となりますことをご了承ください。


0 件のコメント:

コメントを投稿