アプリの構成情報を自動でドキュメント化
ノーコード、ローコードの開発ツールには「開発の手軽さ」という魅力があります。プログラミング知識が無い方であっても簡単に、素早くアプリを作成したり既存のアプリに対して変更を加えたりすることが可能です。しかし、手軽だからといってどんどん機能の追加や改修を繰り返してしまっては、そのアプリのことは開発や改修を行った担当者以外は把握できていない、いわゆる属人化という問題が発生してしまいます。
Forguncyにはそうした問題を防ぐため、設計情報を自動でドキュメント化する機能が搭載されています。開発したアプリの仕様をドキュメントとして残しておくことは、アプリのブラックボックス化を防ぐだけでなく、開発担当者の増員や引き継ぎの際にも役に立ちます。本記事では、Forguncyの設計書自動作成機能の使い方や出力される情報などをご紹介いたします。
Forguncyで自動生成されるドキュメントと出力方法
Forguncyでは開発支援機能の一つとして、設計情報のドキュメントを生成する機能が備わっています。ドキュメントは、Excelファイル形式で出力されます。出力される情報の詳細については後述しますが、画面のスクリーンショット付きの仕様書やデータベースの仕様書など、アプリケーションの構成を理解するのに必要な要素が一通り揃っています。情報の種類ごとにシート分けされており、どこにどのような情報が記載されているのかを示す目次も自動で生成されます。
設計情報のドキュメントを生成するために、特別な準備をする必要はありません。出力したいForguncyアプリケーションのプロジェクトを開き、[ファイル]タブから「ドキュメント生成」をクリックするだけで完了します。
ドキュメントに出力される情報
設計情報ドキュメントに出力される情報は、5つのカテゴリに大別されています。以下に、各カテゴリが扱っている情報の種類や概要についてご紹介します。
プロジェクト概要
「プロジェクト概要」カテゴリでは、そのプロジェクトに関する基本的な情報を扱います。
アプリの基本情報は主に、「プロジェクト情報」シートに記載されています。記載される情報はプロジェクトの名前や保存場所、内部テーブルやビューの数、ページやサーバーサイドコマンドの数など多岐にわたります。
CSSやカスタムWeb API、プラグインなどが使われている場合、種類やバージョンなどの情報も含めそれぞれ専用のシートに記載されます。
アプリの発行に関する情報や、どのユーザー、どのロールにどのページを表示できるようにするかといった運用に関する情報もこのカテゴリに含まれています。
セルの名前一覧シートには、セルやセル範囲に定義された名前があればそれが一覧形式で記載されます。セルの名前は数式やコマンドで使用してセルの値を参照できるようにするというものですが、詳細についてはヘルプを参照してください。
テーブル情報
「テーブル情報」カテゴリでは、プロジェクトに含まれるテーブルに関する情報を扱います。
生成されるテーブルの情報はForguncyの内部テーブルのみでなく、外部データベースのコピーテーブルやリンクテーブルも含まれます。テーブルに関するシートは一覧と詳細に分けられており、一覧シートには主キーやレコードの作成権限、アクセス制御、監査ログの設定などの情報が一覧形式で生成されます。詳細シートでは、各テーブルに含まれるフィールドそれぞれのデータ型、規定値、必須か否かなどの情報が一覧形式で生成されるようになっています。そのほか、テーブル同士の関連付けやビュー、ワークフローに関する情報もこのカテゴリ内に専用のシートが生成されます。
- 開発スタートガイド - ノーコードで作成/連携できるForguncyのデータベース
- 開発スタートガイド - クエリを使ってビューを定義する
- 開発スタートガイド - Forguncyのワークフロー機能でルーティン作業を効率化する
ページ情報
「ページ情報」カテゴリは、アプリに含まれるページに関する情報を扱っており、画面設計書のような役割を果たします。「ページ一覧」シートではプロジェクト内にあらかじめ自動生成されているビルトインページを含む全ページの名前や種類、マスターページなどを確認することができます。アプリの起動時、最初に表示されるスタートページの確認もこのシートで確認できます。ページの種類ごとに分けられたページ詳細シートでは、画面のスクリーンショット付きで各ページに関する詳細情報が記載されています。ページのサイズはもちろん、どのセルにどのセル型を配置したか、そのページで使われているコマンドの情報などもこのシートに含まれます。リストビューに関する情報もこのカテゴリに属します。「リストビュー詳細」シートには、どのページにどんな名前のリストビューが存在するか、そしてそのリストビューと連結されているデータソースは何か、そのフィールドを表示しているかまで細かく記載されています。
サーバーオブジェクト情報
サーバーサイドコマンドの数は「プロジェクト概要」カテゴリのシートに記載がありますが、名前やパラメーター、そしてどのような動きをするのかなど具体的な情報が記されているのがこの「サーバーオブジェクト情報」カテゴリです。一覧シートでは開発者が定義したサーバーサイドコマンドの名前やそのコマンドの概要説明、有効/無効の状態などを一覧表の形式で見ることができます。一方、詳細シートにはコマンドごとに、パラメーターの名前や種類、データの入力規則、戻り値、コマンドの内容などの構成要素が記されています。スケジュールタスクについても同様に、このカテゴリ内に一覧シートと詳細シートが生成されます。
レポート情報
「レポート情報」カテゴリには、プロジェクトに含まれるActiveReportsの技術を搭載したデザイナーで作成したレポートについての情報が出力されます。サーバーオブジェクト情報カテゴリと同様、シートは一覧と詳細の2種類に分けられています。一覧シートでは作成したレポートの名前とそのレポートの出力権限が一覧形式で出力されます。詳細シートには、レポートで使用しているデータソースからレポートのサイズや余白、それぞれのパーツで使用している色やフォントなどの詳細情報が出力されます。シート内にはレポートデザイナーのスクリーンショットも含まれますが、ImageやChartなどの内容は表示されないため注意してください。その他、制限事項についてはヘルプのドキュメント生成の項を参照してください。
Forguncyをもっとよく知る
各業種や用途別にForguncyを活用して、成功した事例や使い方をご紹介します。
