Markdownを利用したHTML/PDFマニュアル作成システムの構築

株式会社両備システムズ　概要

・設立：1969年12月

・資本金：3億円

・従業員数：連結1,556名（2019年12月現在）

・事業内容：公共、医療、社会保障分野および民間企業向けの情報サービスの提供、システム構築、アウトソーシング事業、ソフトウェア開発、他

 ご利用サービス

・マニュアル作成

・Markdownを利用したHTML/PDFマニュアル作成システムの構築

背景

株式会社両備システムズは創業から、行政・医療・健康福祉分野を柱に教育、運輸交通、流通の分野など事業を拡大し、独自ブランドシステムを全国展開。高いブランド力とシェアを誇っています。
製品のひとつの「庶務事務システム」のリリースにあたり、これまで社内で作成したマニュアル作成の外部委託することを検討していました。

庶務事務システム

導入前の課題

ユーザー目線のマニュアルを作成したい

既存のマニュアルには、以下の課題がありました。

①画面や機能を説明した内容になっており、ユーザーの視点に立っていない

②お客様ごとに一部内容が違うマニュアルを管理しており、共通部分のマニュアル更新作業に多大な時間がかかっていた

③作成者によってマニュアルの体裁が異なっていた

④Wordでマニュアルを作成していたが、今後はWebマニュアルが必要

マニュアルが画面・機能の説明に終始し、わかりにくさのため、問合せが絶えない状況でした。

公共ビジネス事業部 内部情報サービス部
総務事務グループ 金澤様

そこで、ユーザー指向のマニュアルになるように構成と内容を見直し、形式をPDF/HTMLへ変更する方針に固まりました。

2019年4月にヒューマンサイエンスWebサイトにお問い合わせをいただきました。

ヒューマンサイエンスを選んだ理由

Markdownでのマニュアル作成ができる技術力

両備システムズでは、GitHubが導入され、仕様書をMarkdownで作成していました。マニュアルは、制作会社で作成後、Markdownで自社で改訂をしていきたいと考えていました。

「外部委託にあたって、3、４社を当ったが、Markdownでの制作を相談するとWordなら、、という回答ばかりだった。Markdownでの制作ができるところがヒューマンサイエンスのみでした」
（公共ビジネス事業部 内部情報サービス部内部情報担当 金澤様、真辺様）

* Markdownとは
Markdownは軽量マークアップ言語の一つで、シンプルな記法で可読性の高いドキュメントを作成できることや、テキストエディタで簡単に編集できることなどの特徴を持っています。GitHubやQiitaなどの著名なWebサービスで採用されるなど、エンジニアをはじめ、IT業界で広く使われている言語です。

導入のプロセス

Markdownの採用

両備システムズ社内では、以前からGitHubを導入し、Markdownにて仕様書を作成していました。マニュアルの原稿データをWordからMarkdownに置き換えることで、仕様書の作成時と同様の環境でマニュアルのメンテナンスを行うことができるため、マニュアルでもMarkdownを採用することに決定しました。

また、GitHub を用いたMarkdownを採用することで、マニュアルの共通部分をマージするだけで、容易にお客様ごとのマニュアルを改訂できます。さらに、フォントサイズや色などのデザインの統一も簡易な手順で実現できるというメリットがあります。

ワンソースマルチユースでのマニュアルデータ制作

Markdownで作成した原稿データをHTMLとPDFの双方に変換する方法として、オープンソースのドキュメント作成ツールGitBookを用いた出力システムを構築しました。

HTMLマニュアル

PDFマニュアル

補助ツールの開発

MarkdownからHTML/PDFへの変換システムを確立後、より簡単にマニュアルのメンテナンスを進められるよう、いくつかの補助機能を備えたGUIツールを開発しました。

たとえば、本システムの基本仕様では、マニュアルの章・節の順序を変更するには手動でMarkdownファイルに変更を加える必要がありましたが、GUIツールにより、直感的な操作で順序変更ができるようになりました。

ヒューマンサイエンスへの評価

お任せでユーザー志向のマニュアルに仕上がり満足しています

開発者には本来の開発業務があります。

マニュアル作成にあたっては、全面的に外部制作会社に丸投げしたいと考えていました。

仕様書、開発デモ環境等を共有したたけで、自分たちの工数をかけずにユーザー志向のマニュアルができあがりました。

公共ビジネス事業部 内部情報サービス部
総務事務グループ 真辺様

Markdownのマニュアルを作成できる会社ということで、選択肢としてはヒューマンサイエンスしかない状況でした。

Markdownへの対応というだけではなく、自分たちの確認の工数をかけることなく、こちらの意図をくみ取ったマニュアルに仕上がり満足しています。