ドキュメント生成ツール「nexacro doc」

nexacro-doc

開発リソースからドキュメントを生成


1.概要

nexacro doc

nexacro platformのリソースから、画面イメージや各UIコントロールの制御内容、一定の規約で記述されたコメントなどをドキュメントとして出力するオプションツールです。

nexacso studioは、GUIツールであり、WYSIWYGとして“見たままの通り動作”します。画面イメージをExcelなどでの“お絵かき”で検討・設計し、その後に実装検証する工程ではなく、設計と検証動作がシームレスに行われます。あるタイミング、または完成時にリエンジニアリングであるドキュメント生成が加わることで、煩雑な画面構築フェーズの生産性を高めるとともに、ドキュメントとリソースの不一致を排除します。

2.ドキュメント生成ツールの必要性

「UXを大切にしない企業に未来はない」と言われるほど、UXは重要です。画面UIはイテレーション(反復)作業を通してUXを高めるもので、「アジャイル思想」や「スパイラルモデル」が適合しています。

一方で、従来のウォーターフォール型開発においては、設計書を書き、承認を経て実装検証を行う。この作業を、結果として反復します。開発契約において、請け負う側が要件を確定するために設計書(書面)を前提にすることは当然です。しかし、重要な目的は情報システム利用者に対するUXです。

高いUXを持つ画面を構築するためには、画面におけるアジャイル的な方法が有効であり、構築する側と利用者側の協調による作業が必要です。これをnexacro studioは支援します。そして、nexacro docを利用することで、運用期間での改修においてもリソースと乖離のないドキュメントを出力することができます。システムの設計段階を含め、システムのライフサイクル中、エビデンスとして機能します。

また、コードの中に「仕様」が書かれていることは、複数の技術者が関わる開発現場における生産性を高めます。

3.利用ステップ

  1. nexacro studioによるコメント
  2.  開発ツール「nexacro studio」にて、規約に則りコメントを記述します。
  3. nexacro docによるドキュメント出力
  4.  出力用ファイルをコマンドラインで指定し、ドキュメントを出力します(HTML形式)。

 

画面1

画面1

画面イメージ(いくつかの出力パターンがあります)

 

画面2

画面2

定義部分(各コントロールの定義)

 

画面3

画面3

ファンクション詳細(ファンクションに対する説明)

画面4

画面4

ソースプログラム(制御部分のコードイメージ)

4.価格・動作環境

  1. 価格:無償
  2. ドキュメント生成時動作環境
  3.  以下の環境が必要です(ドキュメント閲覧時はブラウザのみで動作します)。
     ・Java1.8以上
     ・nexacro platform ver14.0.1.0以上
     ・Chrome Browser ver71.0以上 および ChromeDriver ver 2.45以上(一部機能で利用)