見出し画像

製品マニュアルをWeb化した話

株式会社チームスピリットで「TeamSpirit」のテクニカルサポートをしているNarumiです。
自社では、勤怠管理やプロジェクト管理といった、バックオフィス業務を支えるサービスを展開しており、これらの使い方や仕様を記載したマニュアルも用意しています。
この製品マニュアルを2023年10月から12月にかけて、PDFからWeb記事へリニューアル公開しました。これにより、専用のポータルサイトから簡単に閲覧できるようになりました。ということで、ここに至るまでの道のりを共有したいなと思います。

検索&管理しやすいマニュアルへ🔍

まず、なぜマニュアルをPDF形式ではなくWeb形式にしようとしたのか。
それは以下の大きく3つの面で課題があったからです。
①ユーザビリティ面
 ・
PDF形式の場合、ファイルをダウンロードして開く必要がある
 ・PDF1ファイル100ページ以上の中から該当箇所を探す必要がある
 ・PDFに関連するページへのリンクがなく、関連情報を探しにくい
②メンテナンス面
 
・Word管理のため、1マニュアル内に複数箇所の修正が入る場合でも一人ずつしか修正できない
 ・Wordのレイアウトが修正者の環境差異によって壊れることがよくある
③サポート品質面
 ・カスタマーサポート時にお客様へマニュアルのご案内がしにくい
 ・製品機能の不明点を調べようとしたときに動線がない
 ・どの情報がよく読まれているか分析できず、記載内容を改善しにくい
 ・マニュアルによる顧客の問題解決の可否が判断できず、記載内容を改善しにくい

💪約1年にわたり根気強く進めました

利便性・品質の向上、管理の改善を図ったこの活動は、2021年夏には課題として挙がっていました。その後テクニカルサポートチームが複数名体制となり、マルチ作業をこなせるようになっていった2022年冬から本格始動しました。
大きな流れとしては、対象マニュアルの洗い出し、ページ数の把握、Web化切り替わりに伴う体裁の統一ルール作成、実修正、修正後のチェック、公開作業等をスケジューリングしながら進めました。

リリース時期を意識し、着実に作業をこなす日々が続きました

実作業には、他部署の方々にもご協力いただきました。
例えばNakajiさんとMatsumotoさんには、ひたすらPDFの内容をWeb記事へ転記していただきました。単なるコピペだけではなく、転記後に崩れる体裁の整形や誤記の発見など、リニューアルに欠かせない重要作業を担っていただきました。
また、ShishidoさんとHorikoshiさんには、熟知された製品知識と顧客目線をフルに発揮していただき、マニュアル全体の構成案や細部にまで気を配った提案を数多く行ってくださいました。その内容については、現Webマニュアルにも数多く採用させていただきました。
失敗の許されない専用ポータルサイトへの公開作業についても、多忙にも関わらずさらりとこなしてくださったHagiwaraさん。いやもう本当に頭が上がりません。
度重なるMTGやチャットツール上のやり取りの際にも、いつも温かい対応・リアクションをしてくださいました皆さまに助けられました。

効果を実感すると共に、更なる改善へ🍀

おかげさまで、自社にて展開している製品4つのマニュアルWeb化を2023年12月までに完了することができました。その記事総数は約1,000ページ。圧巻でした……。
さて、このWeb化により、冒頭に挙げていたユーザビリティ面とメンテナンス面の課題が大きく改善されました。利便性が良くなったことで記載内容のご指摘・ご質問をいただく機会が増えるという嬉しい悲鳴もありますが(苦笑)、マニュアル管理方法が変わったことや2024年4月にはドキュメントチームができたことで修正スピードが飛躍的にUPし、情報鮮度を落とさずにマニュアルにその内容を反映できるようにもなりました。
今後は、ページの分析や関連ページのリンク追加など、サポート品質面の向上のために引き続き対応を進めていきたいと思います!

最後に

主業務の傍ら、毎日作業時間を決めて修正が必要な所を洗い出してくれた同じテクニカルサポートチームのMoritaさんとNakakitaさん。やりたいようにやらせてくれ、適宜舵取りをしてくださいました上長Teshimaさん。
チームに恵まれ無事に作業が完遂できました!ありがとうございました!