ソフトウェア開発のおける生産性向上というテーマで
業務がちょっと楽になるアイディアをお届けしていければと思います。

今回は第1回目ということで、ソフトウェア開発におけるドキュメント作成についてお役立ち情報をお届けします。

「ドキュメント」といっても、基本設計書、画面仕様書、テスト計画書、テスト設計書・・・・など、いろいろな種類のドキュメントが存在し、開発スタイルやプロジェクトの方針によってどの程度の粒度で作成するのかは多種多様で正解はありません。

しかしながらサービスの規模が大きくなったり開発者の数が増えるにつれ、スキルや製品の理解度にばらつきがでるため、属人化を防ぎ、「正しい仕様」を残していくことが必要になります。

既存システムで各仕様書の更新が止まってしまっているという方も少なくないでしょう。
今から全機能の仕様書を更新するのはリソース的にも期間的にも不可能という場合、現在のアプリのスクリーンショットを撮影し画面上の正解と各画面への遷移の情報を残しておくだけでも正解の画面と挙動を伝えるという意味で、充分仕様書としての効果を発揮することが可能です。

画面設計書とは、システム構築においてどんな画面が表示されるのかを設計したものです。要件を文字でまとめるだけでなく、画面上のどの位置にどのような操作をする部品を配置するのかを画面設計書で明記し、デザインを含め定義しています。サービスを運用するマーケティング部門やクライアントは、画面上の配置まで細かく指示してくることはありませんが、このような操作がしたいという漠然としたイメージは持っているため、画面設計書を作成し完成後のイメージを共有しておくことで、クレームや手戻りを防ぐことができます。仕様の正しさを伝える資料としての活用や、システムの構築前に想定している仕様とデザインを確認するための資料としても活用ができます。

画面仕様書はいろんな人が閲覧するためパワーポイントやExcelなどoffice系のソフトを利用することが少なくありません。
画面設計を行う際には、以下のポイントに注意して作成します。

・共通情報の明記
・モジュール/コンポーネントごとにまとめる
・フォーマットを統一し、属人化を防ぐ

画面レイアウトと画面遷移をなるべく標準化し、プロジェクト名、工程名、バージョン情報、作成日、作成者、更新日、画面部品の定義などの共通ルールをドキュメントにまとめて記述しておくことが必要です。画面レイアウトと画面遷移を共通化することで、個別の工程成果物の記述量を減らせるのでレビューを大幅に効率化できるほか、設計の品質や生産性が上がります。
また、モジュール/コンポーネントごとにまとめておくことで、重複記載を防ぎ仕様変更の際ドキュメントも更新漏れを防げるようになります。
また、チームや会社全体でフォーマットを統一することで誰もが見やすく、更新しやすくなるため属人化を防ぐことができます。

スクリーンショットを画面仕様書に添付する際、画面のスクリーンショットを取得し、画像フォルダの画像をスマートフォンからPCに移動し、ファイル名を変えてExcelなどに貼り付けを行うという作業が発生します。画面数が多くなると画像の整理だけでもとても工数がかかります。これらの作業はRemote TestKitの機能を使うと、直接ドキュメントに画像をはりつけたり、直接ＰＣに画像を保存することができます。また、ドキュメントを作成しながら、適所で画像をとりにいくことができるので、作業が細切れにならず、集中力が持続しやすくなるのもメリットです。

画面仕様書以外にも、不具合報告書や顧客への説明資料など、画像を貼り付けたいシーンは多く存在するので様々な役割の方の便利ツールとなるでしょう。

スクショ機能はこちらのコラムで詳しくご紹介しています
テストのエビデンス管理対策とは？4大問題と実機検証ノウハウ

ドキュメント作成や更新は手間のかかる作業ですが、サービス品質を保つためには重要なタスクです。便利なツールを活用しながら、時間とリソースを有効活用していければと思います。

執筆者：A.K
第三者検証サービスの営業として、日々様々な課題を持つお客様と対峙。
仕事のモットー：自分のハンドルは自分で握る！

Tweet