IBM i自身による文書化に成功

次期製品Chao!! は自分自身による
文書化に成功しました。

ソリューション開発だけでなく
社内の文書化は面倒なものですが
知識の共有は必要なものです。

この度製品化だけでなく
製品メニューから自動的に文書化も
成功しました。

■ メニューからプログラムまでを文書化

UIMメニューを自動的に解析してツリー構造として
構造化されている場合でも最下位の階層レベルまで
自動的にすべて解析して文書化します。

プログラムに関してはコマンドそのものを
API:GETCMDDOCによってコマンドの構造やパラメータを
漏れなく正確にHTMLに変換してコマンドに登録されている
ヘルプ文書をプログラムの説明として取り出して
HTML文書を作成します。

画面の画像は手作業で取り出す必要はありますが
画像の記述も文書化によって追加記述されます。

■正確でつねに最新の文書化を

製品:Chao!! の文書化は弊社の公開IBM iに配置されて
後悔されますので製品に機能の追加・変更があれば

[コマンド: CRTMNUDOC]

                       メニュー文書化の作成  (CRTMNUDOC)                  
                                                                          
 選択項目を入力して，実行キーを押してください。                           
                                                                          
 メイン・メニュー  . . . . . . .   CHAO           名前 , *ALL             
   ライブラリー  . . . . . . . .     CHAO.COM     文字値 , *ALL, *ALLUSR  
TO ディレクトリー  . . . . . . .   '/DOC/MENU/'                           
                                                                          
                                                                          
 ファイルの置き換え  . . . . . .   *YES          *YES, *NO                
                                                                          

[解説]

UIMメニューをHTMLツリー構造に文書化します。

▼ UIMメニーは次のようにHTMLのツリー・ビューに変換されて
表示されます。

[コマンド: CRTCMDDOC]

                        コマンド文書化の作成  (CRTCMDDOC)                  
                                                                           
  選択項目を入力して，実行キーを押してください。                           
                                                                           
  コマンド  . . . . . . . . . . .   *ALL           名前 , *ALL             
    ライブラリー  . . . . . . . .     CHAO.COM     文字値 , *ALL, *ALLUSR  
 TO ディレクトリー  . . . . . . .   *LIB                                   
                                                                           
                                                                           
  ファイルの置き換え  . . . . . .   *YES          *YES, *NO                
                                                                           

[解説]

ライブラリーCHAO.COMの対話式コマンドのすべてを
GENCMDDOCとヘルプ文書によって取り出してHTMLに文書化します。
　
▼メニュー項目をクリックすれば下記のような画面イメージとヘルプが
HTMLとして表示されます。

■ 文書化メニューを作るには

IBM ユーザーの多くの業務メニューはDSPF と CLPで作成されていることが
多いようですがIBMユーティリティー・メニューのほとんどはUIMメニューと
実行はコマンドで構成されています。
オフィスクアトロの製品もIBMユーティリティ同様、UIMメニューとコマンドで
構成されておりコマンドに説明はヘルブに収められています。
そのため文書化も容易に実現することができました。

この文書化された結果は後々ネットで公開を予定しています。
また今後の弊社製品も上記のユーティリティーによって
自動文書化によって保守公開していく予定です。