BACKGROUND
開発に集中するため、ユーザーガイド制作を手放したい
特定領域向けのBtoBパッケージソフトで、大幅な機能アップデートが行われることになりました。
それに伴い、既存のユーザーガイドも大きく更新する必要がありました。
これまでユーザーガイドや技術的なガイドは開発責任者自身が作成していましたが、今回は開発そのものに集中する必要があり、ユーザーガイドの更新まで担う余力がない状況でした。
そこで、ユーザーガイドの更新をTAQTが担当することになりました。
APPROACH
まず、プロダクトを理解する
いきなりドキュメントの更新から始めるのではなく、まず実際にプロダクトを操作し、既存のユーザーガイドを確認しながら、基本的な機能や操作を理解しました。
さらに企画書や要件・仕様関連のドキュメントを確認し、今回のアップデート内容を整理。疑問点は開発責任者との会話を通じて確認しました。
大きく合わせて、小さく確認する
詳細な制作に入る前に、ユーザーガイド全体のアウトラインと更新方針を作成し、開発責任者とレビューしました。
全体の方向性を合わせたうえで、既存ガイドの記述ルールや体裁に合わせて詳細化。
必要な画面を整理し、検証版のプロダクトを操作してスクリーンキャプチャを取得しながら、ユーザーガイドへ反映しました。
制作中はGoogleドキュメント上で小さな単位ごとに作成・レビュー・修正を繰り返し、完成後には開発責任者と営業担当者による公式レビューを実施しました。
POINT
専門性の高いプロダクトを、自分たちで理解する
仕様書から文章を作るだけではなく、実際にプロダクトを操作し、既存ガイドや関連資料も確認することで、利用者の視点からプロダクトを理解することを大切にしました。
利用者を意識した表現
専門性の高いプロダクトであることを踏まえ、既存ガイドとの整合性を保ちながら、利用者にとって適切な表現や説明になるよう整理しました。
認識のずれと手戻りを小さくする
最初にアウトラインと方針という大きな単位で認識を合わせ、その後は小さな単位でレビューを繰り返しました。
認識のずれを早い段階で確認することで、大きな手戻りを防ぎながら制作を進めました。
RESULT
開発責任者が、開発に集中できる状態へ
ユーザーガイドは予定していた納期までに完成し、大きな手戻りなく開発責任者・営業担当者によるレビューを完了しました。
完成したガイドは、プロダクトのリリースに合わせて正式なユーザーガイドとして提供されました。
ユーザーガイド制作をTAQTが担うことで、開発責任者は制作作業から離れ、本来注力すべき開発に集中することができました。
その後も、追加の依頼や相談につながっています。