設計書自動更新・管理サービス

設計書と、実際のアプリケーションなどが完全に一致しているシステムは世の中に存在するでしょうか?そもそもアジャイル方式で作成されたシステムでは、最初に設計書が存在しない場合もあります。ウォーターフォール形式の場合でも、開発段階でステークフォルダからの要望で仕様変更が行われたりすることで、設計書とシステムの乖離が生じることが多く、問題になっています。

開発・運用をDevSecOpsでサイクルさせるためには、設計書とシステムの同期は非常に重要です。オン・デマンド・ワンの「設計書自動更新・管理サービス」AppDocOneをご利用いただくと、設計書とシステムの乖離問題から解放されます。

AppDecOneの設計書自動更新・管理

  • AppDocOneはアプリケーションのソースコードから クラウド上に 設計書情報を生成します。
  • 生成された設計書情報には任意のコメントやメモを記入できます。
  • 日々のシステム改修や、機能追加・変更が行われたら、マージ機能で設計書情報を更新できます。以前に記入したコメントやメモはそのまま引き継がれます。
  • 設計書情報はバージョン単位でクラウド上で管理され、いつでも任意のバージョンノ設計書をExcelファイルとしてダウンロード可能です。

AppDocOneでの設計書自動生成の実際

Chrome 拡張機能を使用したページ解析

AppDocOneのご利用をお申込みいただくとAppDocOneのサイトからChrome 拡張機能のダウンロードができます。
お使いのChrome ブラウザにダウンロードした拡張機能をインストールしてください。

設計書の自動生成を行いたいWebページを開き、そのままAppDocOneの拡張機能を開きます。
Project IDとUpload ID、それにパスワードを入力して "ページを解析する" のボタンをクリックします。

このページの下方にはお問合せ内容などの入力欄が配置されています。

正常に解析が終了すると、下記の様にアップロード完了のメッセージが表示されます。

この状態でAppDocOneのプロジェクト.アップロード一覧画面を開くと、ページ解析を行った画面の情報が登録され、閲覧・編集が可能な状態になっています。

生成された設計書 - 項目番号付きスクリーンショット-

入力項目や、リンク項目に番号が振られたスクリーンショットが生成され、その番号に対応する項目の種類やリンク先情報の一覧が作成されます。

生成された設計書 -番号に対応する項目一覧-
設計書の編集

作成された項目一覧には備考欄、TAB順の記入欄、説明の記入欄があり、AppDocOneの画面から入力・保存が可能です。

このようにして解析、および更新された画面情報は、AppDocOneの画面からExcelファイルの形式でダウンロードすることができます。

設計書のダウンロード (Excelファイル)
ダウンロードしたExcelファイルの内容 (画像のクリックで拡大します。)
変更履歴
スクリーンショット
項目一覧
設計書の更新 -入力項目を追加して設計書を更新-

お問合せ内容の入力欄に携帯電話番号の入力欄を追加して、その画面の情報を、AppDocOneに取込ます。

この画面を開き、Chrome の拡張機能でHTML情報をAppDocOneにアップロードします。

AppDocOneで作成された設計書 -項目番号付き画面情報-

追加された携帯電話番号の入力項目に番号が割り振られています。

AppDocOneで自動更新された設計書 -項目一覧-

携帯電話の入力項目が一覧に追加されています。 また、最初に作成した一覧に記入した備考と説明欄は登録された内容がそのまま表示されています。

設計書変更履歴 -バージョン管理-

携帯電話番号の入力項目が追加される前の状態をVersion1、追加された後をversion2として変更履歴を編集します。

初版作成はあらかじめ入力されています。ここでは、2.0版の変更内容を記入します