WordやFrameMaker、InDesignでのマニュアル作成、管理をもっとラクに
GitHub^※とMarkdown/Asciidoc^※でマニュアル作成コストダウン
～開発現場とのスムーズな情報連携でマニュアル作成を加速～

Word、FrameMaker、InDesignなどでのマニュアルや技術資料の作成に限界を感じてはいませんか？
そのようなお客様向けに、GitHub等のオープンソースを活用したマニュアル作成環境の構築を提供しています。

 

※GitHub（ギットハブ）とは
ソフトウェア開発に使われるソースコード管理ツールです。ソースコード管理だけではなく、仕様書などのドキュメント管理・共有ツールとしても活用されています。 マニュアル作成においては、変更履歴記録、複数ユーザーによる同時作業などが可能です。5ユーザー　25ドル/月から使用できます。

 

※AsciiDoc（アスキードック）とは
Markdownなどのような軽量マークアップ言語の一つです。テキストエディタで記述しHTML、PDF、電子書籍、など種々の形式に変換することが可能です。

 

GitHubとMarkdown/Asciidocでの
マニュアル作成のメリット

1. システム導入　50％コストダウン

マニュアル作成・管理のためにCMSを導入する場合、通常1000万以上の費用が必要となります。多くの企業にとって、システム導入費用は大きな負担としてのしかかります。
GitHubとMarkdown/Asciidocでのマニュアル作成は、オープンソースソフトウェアを活用するため、作成環境のイニシャルコストを抑えることができます。

「システム導入時に高額な予算を準備できない。」
「スモールスタートで試したい。」
「ハードウェアやソフトウェアの年間ライセンス費用などの維持費を押さえたい」

このようなお客様にぜひお試しいただきたいサービスです。

 

※Atom（アトム）とは
GitHubが開発したオープンソースのテキストエディターです。

※静的サイトジェネレーターとは
Markdownなどで書かれたファイルをもとに、効率よくHTML/CSSを生成するためのツールです。

2. 拡張性

欲しい機能に対応したオープンソースソフトウェアを選択することで、パッケージ製品と比べて自社作成フローに合わせて柔軟に拡張できます。
どのようなツールの組み合わせが最適かは、ご要件に応じてヒューマンサイエンスがサポートいたします。
例えば、GitHub社が提供しているオープンソースエディタであるAtomには、多様なプラグインが提供されています。自社の作成フローに合わせて、欲しい機能を組み合わせることで使いやすい環境を構築できます。

 

その他の例

・Sourcetree（Gitをコマンドラインではなく、GUIで操作できる無料ツール）
・Redpen（文章校正ツール）
・textlint（文章校正ツール）

 

3. DTPコスト100％削減

20年前のマニュアル提供形態は紙が主流でしたが、現在は、PDFに加えてWebマニュアルなどHTMLなどでの提供が前提となることが殆どです。
従来は、Word、FrameMaker、InDesignで版下を作成することが多く、DTPやHTMLコーディングに多くの時間を要していました。
本ソリューションでは最初にHTMLやPDF用のテンプレートを作成しておけば、ルールにそってテキスト原稿を作成するだけでDTP編集することなくHTMLやPDFを出力できます。
DTP工程が100％削減できます。

 

4. 関係者との連携が円滑に

マニュアルの作成体制は会社によって異なります。

①エンジニアが業務の一環としてマニュアルを作成する
②エンジニアから情報を得て、ユーザーサポート部が作成する
③エンジニアから情報を得て、マニュアル専門部署が作成を行う

いずれの場合も、部署間・部署内でのコミュニケーションが重要になります。

製品が発売、納品されるまでは、幾度の仕様変更が発生します。また、リリース後も、バージョンアップなどによるマニュアルの改定が行われおり、マニュアルデータの版数・変更履歴の負荷が高いものでした。

「エンジニアからの情報のとりまとめが大変」
「マニュアルやドキュメントのデータ共有が煩雑で、データの管理に手間がかかる。」
「修正の履歴管理が煩雑になりがち」

 

GitHubを活用することで、ファイルの世代管理や修正履歴の管理が容易です。
いつ、誰が、どのような修正をしたかなど細かい履歴も確認することが可能になります。
GitHubのプルリクエスト機能を使うことで、レビュー依頼やフィードバック、対象ドキュメントを一括で連絡できるため、コミュニケーションを円滑に行えます。
GitHubのリポジトリ上でデータ資産を共有できるため、権限保有者間でデータを共有できます。
閲覧・編集権限などのユーザー権限が設定できます。

5. エンジニアに親和性のある記述形態

Markdown、Asciidoc、reStructuredTextといったエンジニアに馴染みのある記述形態（軽量マークアップ言語）を採用することで、原稿作成をストレスなくできます。
開発現場ではWord、Excel、PowerPointと並び、「軽量マークアップ言語」が利用されているケースがあります。
開発現場で使われているテキスト形式には以下のようなものがあります。

Markdown
シンプルなスタイルで記述できるのが特長。
メモ書き程度の簡単な文書作成に適している。

Asciidoc
Markdownに比べてスタイルが豊富。
コストを抑えながら見栄えの良いレイアウトにしたい場合に最適。
技術文書、マニュアルに適している。

reStructuredText
理科系分野で利用されている記法。
Pythonのコミュニティ内で広く使用されている。

 

お客様マニュアル使用の目的や運用体制に合った記述形式をご提案いたします。

6. マルチデバイス対応

7. Trados、Memsourceと連携

翻訳ツールのスタンダートであるTrados、Memsourceと連携し、日本語マニュアルから翻訳までGitHub上でワンストップのプロジェクト管理が可能です。

※Markdown形式は、Memsourceに対応しています。

価格表

主なサービスの費用の目安です。ご要望に応じてお見積いたします。お気軽にお問い合わせください。

ヒューマンサイエンスのサービス

1. 1. GitHub導入支援
   • ・GitHubの料金調査と予算に合った環境のご案内
   • ・Markdown編集用エディタのご案内
   • ・エディタ用プラグインのご案内
   • ・CIツール設計
2. 2. 作成ガイドラインの作成
   • ・運用フローの素案作成
   • ・実運用時のポイントや留意点の洗い出し
3. 3. 作成環境の構築
4. 4. HTML用のスタイル定義ファイル（CSS）作成
5. 5. PDF用のスタイル定義ファイル（YAML）作成
6. 6. TC観点に沿ったMarkdown等のリライト
7. 7. MarkdownやAsciidocなどのTrados翻訳
   • ・既存資産（Wordなど）からMarkdownやAsciidocへのデータ変換
   • ・MarkdownやAsciidoc等のTRADOS翻訳用のデータ変換 etc..
8. 8. GitHub初心者対象の基礎セミナー

OSSシステム無料ダウンロード

AsciiDocとGitHubを活用したOSSマニュアル作成システムをGitHub上で公開しております。

テンプレート、HTML変換、PDF変換の機能を備えたシステムで、テンプレートを活用し、原稿を作成、HTML、PDF生成が可能です。

オープンソースで、GitHubアカウントをお持ちの方であればどなたでも無料でダウンロード可能です。

https://github.com/human-science/adpy/blob/master/README-ja.adoc

adoc、html、pdfフォルダ内よりOSSシステムを使用し生成したサンプル（HTML、PDF）をご確認いただけます。

※PDFは下記ブラウザで閲覧可能です。HTMLはダウンロードの上ご覧ください。

https://github.com/human-science/adpy/blob/master/pdf/ja/toc_ja.pdf

事例

• 

  ヤマハ株式会社様

  • 【コスト削減30％】AsciiDocとGitHubでPDF、
    HTMLマニュアルのデータを部署をまたいで一元管理
    
    

関連サービス