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

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

1.概要

nexacro doc

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

nexacro 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 14 ver14.0.1.0以上
     ・Chrome Browser ver71.0以上 および ChromeDriver ver 2.45以上

静的解析ツール「nexacro lint」

静的解析により悪影響を及ぼすコードを発見


1.概要

nexacro lintは、nexacro beyondのプロジェクト内に記述されたJavaScriptのコードに対して、静的解析を行うためのオプションツールです。

nexacroプロジェクトに含まれるJavaScriptは、画面ソース内に画面定義情報(XML)と混在しているため、一般的なLintツールをそのまま使用することができませんでした。nexacro lintでは、OpenJS Foundation によるオープンソースプロジェクトで開発されている静的解析ツール「ESLint」のプラグインとして構成されており、nexacroプロジェクト内のJavaScript コードに対する静的解析を可能としています。

2.静的解析ツールの必要性

プログラムの正しさを検証するために、テストを作成して機能要件を満たしていることを確認する事は重要ですが、プログラムコード上に構造上の問題がないことを確認する事も重要です。JavaScriptはそのコードが実行されるまで文法的な正しさを確認することができず、高い柔軟性のために結果的に意図した通りになるコードでも、構造上の問題を内包していることがあります。

このような構造上の問題点は、間接的に他のコードの実行を阻害し、原因究明が非常に困難になる場合があります。Lint ツールは、プログラムコードを静的に解析することで、信頼性や効率に悪影響を及ぼすようなコードの問題を発見します。

3.利用ステップ

・静的解析の実行
 コマンドラインで、対象となるプロジェクトを指定し、静的解析を実行します。

静的解析の実行

※デフォルト設定による出力例です。出力内容は設定ファイルによってカスタマイズ可能です。

検出できる内容
nexacro lintでは、OpenJS Foundation によるオープンソースプロジェクトで開発されている静的解析ツール「ESLint」のプラグインとして構成されおり、ESlint標準機能に加えてnexacroプロジェクト内のJavaScript コードから以下の内容を静的解析によって出力します。

4.価格・動作環境

  1. 価格:無償
  2. 動作環境

以下の環境が必要です。

「nexacro beyond」製品へのお問い合わせ

お気軽にお問い合わせください。

お問い合わせはこちら>>