ドキュメントクリエイション
~仕様書・画面一覧・取扱説明書・マニュアル作成サービス~
TOP
›
ソフトウェアテスト・QA(品質保証)サービス | 株式会社ProVison
›
ドキュメントクリエイション ~仕様書・画面一覧・取扱説明書・マニュアル作成サービス~ | 株式会社ProVision
a 開発プロジェクトにおけるドキュメント
(仕様書・画面一覧・取扱説明書・マニュアル等)
足りていますか?
現時点でドキュメントがなくても、貴社サービスや手元にある各種資料(画面遷移図や不具合チケット等)から
仕様書・画面一覧・取扱説明書・社内またはユーザー向けマニュアル等のドキュメントの作成を行います。
特に、開発スピードを重視し、必要最低限のドキュメントで進行する「アジャイル開発」と相性が良く、
開発業務の効率化や品質の向上にお役立て頂けます。
ドキュメント(仕様書•画面一覧•取扱説明書•マニュアル等)を作成する目的
仕様書とは
ソフトウェアや製品、システムなどの詳細な要件を記述する文書を指します。
機能、性能、インターフェース、ユーザビリティなど、ソフトウェアや製品、システム全体の仕様が記載されています。
仕様書があることで
- プロジェクトに関わるメンバーが、システムやサービス、ソフトウェアなどの詳細な要件を把握することができます。
- 新たにプロジェクトに参画したメンバーの仕様理解が均一に、スピーディーに行えます。
- 機能追加時、仕様書を基に既存機能との仕様不整合をチェックすることが可能です。
画面一覧とは
システムやサービス、アプリケーション等の設計時に作成される、画面の一覧です。
各画面には画面名、画面の目的、機能、要素、遷移先などが記載されます。
各画面には画面名、画面の目的、機能、要素、遷移先などが記載されます。
画面一覧があることで
- プロジェクトに関わるメンバーが、システムの全体像を把握できると共に、各画面における機能・要素を理解することができます。
- 開発やテストをスムーズにしたり、進捗管理、タスクの割り当てにも役立ちます。
業務マニュアルとは
業務の流れや手順、ポリシー、規則などを記述した文書のことです。
業務マニュアルは、担当者が業務を適切に行うためのガイドとなります。
また、業務マニュアルは組織の業務の品質管理、業務の規約の保存、業務の変更に対応するための情報の準備などにも役立ちます。
業務マニュアルは、担当者が業務を適切に行うためのガイドとなります。
また、業務マニュアルは組織の業務の品質管理、業務の規約の保存、業務の変更に対応するための情報の準備などにも役立ちます。
業務マニュアルがあることで
- 担当者がマニュアルに沿って、安定的にシステムを運用することができます。
- 担当者が増えたり代わったりする際も、マニュアルに沿って運用することでミスやエラーを軽減できます。
FAQとは
「Frequently Asked Questions」の略で、システムやサービス、アプリケーション等の仕様や操作について、
頻繁に質問される内容をまとめたものです。
FAQは、ユーザーサポートや製品の説明などで使用されることが多く、頻繁に質問される内容に対する短い回答と対で構成されています。
また、ユーザーが簡単に情報を探すことができるように整理されています。
頻繁に質問される内容をまとめたものです。
FAQは、ユーザーサポートや製品の説明などで使用されることが多く、頻繁に質問される内容に対する短い回答と対で構成されています。
また、ユーザーが簡単に情報を探すことができるように整理されています。
FAQがあることで
該当のシステムやサービス、アプリケーション等を利用するユーザーの疑問や問題を解決したりすることができます。
また、メールや電話等によるユーザーからの問い合わせを減らし、カスタマーサポートの負荷を軽減することが可能になります。
また、メールや電話等によるユーザーからの問い合わせを減らし、カスタマーサポートの負荷を軽減することが可能になります。
仕様書・画面一覧・取扱説明書・マニュアルを作成する際のポイント
仕様書を作成する際のポイント

- システム全体の仕様が抜け漏れなく記載されているか
- 仕様の不整合が発生していないか
- 仕様変更や追加した内容がが追記されているか
- 不具合や異常状態に対するエラー定義が記載されているか
画面一覧を作成する際のポイント

- システムで表示される可能性のある全ての画面(エラー画面含む)が漏れなく記載されているか
- 各画面における機能が抜け漏れなく記載されているか
- 画面や機能メニューの表示/非表示の条件が記載されているか
- エラー画面を表示する条件が記載されているか
業務マニュアルを作成する際のポイント

- 初めて操作する人でも実行できる、わかりやすい内容になっているか
- 操作する上で必要な前提条件等の情報が記載されているか
- 操作する上で注意すべき事項が記載されているか
- 操作方法の変更があった際、情報が更新されているか
- エラー発生時の対処方法が記載されているか
FAQを作成する際のポイント

- エラー発生時の対処方法が抜け漏れなく記載されているか
- わかり辛いと思われる仕様がFAQとして記載されているか
- 既知の軽微な不具合がある場合、FAQとして記載されているか
- 機種固有で発生する不具合がある場合、FAQとして記載されているか
ProVisionのドキュメントクリエイション
(仕様書・画面一覧・取扱説明書・マニュアル等)サービスとは?
貴社サービスや手元にある各種資料(画面遷移図や不具合チケット等)から
仕様書・画面一覧・取扱説明書・マニュアル等、必要なドキュメントを作成します
実際の動作

実機にて挙動確認をし、
仕様把握やキャプチャーを取得
遷移図

全体図の把握から作成範囲確認
試験項目書

試験項目書から様々な前提条件や
境界値などを把握
開発資料・チケット

JIRA・Backlog等点在している
仕様をまとめる
ドキュメントクリエイション
(仕様書・画面一覧・取扱説明書・マニュアル等)の流れ


ドキュメントクリエイション
(仕様書•画面一覧•取扱説明書•マニュアル等)サービスの導入事例
画面設計書
対象サービス
デジタル教材サービス
- 課題
- 画面設計書の更新に手が回らず、アップデートができていない
- 仕様書や不具合チケットなど、各所に情報が散乱している状態で、ドキュメント全体として整合をとりたい
- 検証事例
- 各種ドキュメント・チケットの内容と実際のサービスの動作を確認しながら、仕様書・画面設計書を最新の状態にアップデート
マニュアル
対象サービス
座席位置管理システム
- 課題
- 社員向けにシステム利用マニュアルを作成してほしい
- 作成事例
- 仕様書はなかったが、テスト設計書や実際のシステムの動作を確認しながら、各機能の操作手順をマニュアル化
また、あらかじめ間違えやすい点・分かり辛いと感じる点を洗い出し、Q&A方式で記載
マニュアル
対象サービス
自動車輸送システム
- 課題
- システムを利用するスタッフに年配の方が多く、安全に運用するためにわかりやすいマニュアルが必要 既存のユーザーマニュアルを改版して、平易なわかりやすいものにしてほしい
- 作成事例
- テスト実施時に各画面のキャプチャを取得し、既存のマニュアルに追加することで視覚的に理解できるよう工夫し、 システムアップデート時には最新の画面のキャプチャに置き換えることで、いつでもだれでも使えるマニュアルを作成
ドキュメントクリエイション
(仕様書•画面一覧•取扱説明書•マニュアル等)サービスに関する
よくある質問
Q現時点でドキュメントがない状態です。
ゼロからの仕様書・画面一覧・取扱説明書・マニュアル等の作成は可能でしょうか?
A対応可能です。 手元にある資料や実際のサービス・システムを操作しながら作成します。 仕様が不明な部分については、都度お問合せをさせて頂く形で作成して参ります。
QQA(テスト)と平行してドキュメントを作成することは可能でしょうか?
A対応可能です。
テスト工程時に、仕様理解やキャプチャ取得等が可能である為、より効率的にドキュメントを作成できます。
Q遠方からの依頼も対応可能でしょうか?
A対応可能です。
お手持ちの資料のご提供および、操作可能なサービス・システムがあれば遠方からのご依頼でも問題ございません。
Qドキュメント作成における制作進行もお任せすることはできますか?
A問題ございません。
開発担当者様とのコミュニケーションにて、弊社担当者が作成して参ります。
進行状況のレポートも実施致しますので、安心してお任せください。
関連サービス

© ProVision Inc. All Rights Reserved.