Markdownを活用したHTML/PDFマニュアル作成システムの構築で、ユーザー志向で保守性の高いマニュアルを実現
両備システムズは、既存のマニュアルが画面・機能説明に終始し、ユーザー視点に欠け、顧客ごとの異なる内容管理に時間がかかっていた。Markdownを採用し、GitBookを用いたHTML/PDF変換システムと補助GUIツールを構築することで、ユーザー志向のマニュアルを実現し、メンテナンス工数を大幅に削減した。

- 導入企業
- 株式会社両備システムズ
- 業種
- IT・ソフトウェア
- 規模
- 従業員数1,556名(連結、2019年12月現在)
- 部門
- 公共ビジネス事業部 内部情報サービス部
- 解決した製品
- Markdownを利用したHTML/PDFマニュアル作成システム(GitBook、GitHub活用)(science.co.jp)
- 従業員数(連結)
- 1,556名
01課題
既存マニュアルはユーザー視点に立たず画面・機能説明に終始していた。顧客ごとに異なるマニュアルの共通部分更新に多大な時間がかかり、作成者による体裁のばらつきがあった。さらに、Word形式から今後のWebマニュアル対応が必要だった。
02やったこと
Markdownでのマニュアル作成を採用し、GitHubでの仕様書作成と同じ環境でメンテナンス可能にした。オープンソースのGitBookを用いてHTML/PDFへの変換システムを構築し、ワンソースマルチユースを実現。さらに、章・節の順序変更を直感的に行えるGUIツールを開発した。
03成果
ユーザー志向のマニュアルに仕上がり、開発者の工数をかけることなくこちらの意図をくみ取ったマニュアルが完成。Markdownでの自社改訂が容易になり、共通部分のマージで顧客ごとのマニュアル改訂が簡単に実現でき、デザイン統一も簡易な手順で可能になった。
本ページは掲載元の公開事例の要約です。詳細・一次情報は出典元をご確認ください。 掲載内容の修正・削除のご依頼はこちらの窓口へ。
この事例に興味があるなら
似た悩み・別の解き方の事例を、おすすめの理由つきで。
マニュアル品質改善とデータ一元化でコールセンター問合せ削減と制作工数を大幅削減
大幅同じ「手順書がない」を、コンサル・支援・マニュアル改善コンサルティング・Wordプラ…という別の入口から解いた1本。
紙・Excel中心の間接業務をワークフロー化、購入稟議8.8日→5.5日に短縮
8.8日→5.5日同じ「手作業の転記」を、業務SaaS・SmartStage ServiceDeskという別の入口から解いた1本。
PMO導入による組織的マネジメント力向上で、プロジェクト受注数拡大と売上アップを実現
コストオーバーや納期遅延が2年間発生なし同じ〈業務効率・工数削減〉の悩みに向き合った会社の選択を、並べて読める1本。
セキュリティシステム製品のUI日本語化ローカライズ:品質向上と工数削減を実現
同じ「手作業の転記」を、コンサル・支援・UI・ソフトウェア翻訳サービスという別の入口から解いた1本。
CMS導入とマニュアル改善で、ユーザビリティと保守性を向上
同じ「手順書がない」を、Author-itという別の入口から解いた1本。