• 東京03-5321-3111
  • 名古屋052-269-8016

Some parts of this page may be machine-translated.

IT企業向けドキュメントソリューション

IT企業向け
ドキュメント
ソリューション

開発者の皆様、ドキュメント作成・管理にお悩みではありませんか？

ほとんど更新されていない
古いまま放置されている
APIリファレンスが読まれない
活用されていない・・・
IT企業では、そんなお悩みをお持ちの企業様が増えています。

ドキュメントプラットフォームを刷新したり、新しく検討するものの、マーケットには、様々なプラットフォームが存在するため、どれが最適なのかわからない・・・

そんなお悩みはないでしょうか？

実は・・・
扱うドキュメントのタイプによって最適なプラットフォームは変わります

あらゆる業種・業界に汎用的に適用できるプラットフォームは、存在していません。
そこで、プラットフォームの選定にはカギとなる視点が必要です。
ヒューマンサイエンスは、特定の製品にこだわらない、中立的な立場で、
お客様の課題やドキュメントに適したプラットフォームの導入を支援します。

プラットフォーム選定に必要な観点

扱うドキュメントの種類によって、特徴や利用シーン、運用方法は様々。
プラットフォームに求められる機能やスペックも異なります。

そこで、必要となる観点は３つ
「ドキュメント」「読む人」「作る人」という３つの視点で各ドキュメントの特性を捉える必要があります。

▼ 横にスクロールできます

製造（技術者・専門職）
向けマニュアル		 社内業務マニュアル IT（開発者）向け
ドキュメント
ドキュメントタイプ（例） ・製品マニュアル
・サービスマニュアル
・取扱説明書		 ・業務システムマニュアル
・営業マニュアル
・接客マニュアル
・事務マニュアル		 ・チュートリアル
・APIリファレンス
特長 マニュアル1冊のボリュームが多く、更新頻度は高くないが、分冊が多い傾向。現場スタッフが紙でマニュアルを見るケースや、多言語版のマニュアルが必要なケースもある 数ページ～数十ページのものが大量にあるケースが多く、散在していて一元管理が難しい。内容が頻繁に更新されるため最新の情報をタイムリーに提供する必要がある 更新頻度が高く、開発プラットフォームで作業しながらドキュメントを作成・閲覧するケースが多いため、開発環境からアクセスしやすいプラットフォームが望まれる
ドキュメント 1冊あたりのボリューム
※A4に換算した場合		 数百ページ 数ページ～数十ページ 百ページ程度
分冊構成
冊数		 目的によって数冊に分けられる（取付編、操作編など）
多言語翻訳版も存在		 業務量によって数冊～数十冊になる 目的によって数冊に分けられる（チュートリアル、APIリファレンス）
読む人の視点 読み手 現場の技術者やサービススタッフなど 社員 ITエンジニア
ITリテラシー 高くない人も含まれる 部門によって様々 高い
作る人の視点 作成者 マニュアル部門、設計・開発部門、制作会社など 対象業務の主観部門、業務支援部門など ITエンジニア
読み手・作成者が同じケースも多い
更新頻度 メインバージョンアップ、マイナーバージョンアップに伴い随時更新
更新頻度は高くない		 最新の情報をタイムリーに提供する必要がある
更新頻度が高い		 メインバージョンアップ、マイナーバージョンアップに伴い、頻繁に更新

IT企業のドキュメント環境の運用者は開発者
開発者が使いやすいプラットフォームを選定しましょう！

プラットフォームを選定する際には、
該当するプラットフォームが、
「どのドキュメント類をメインターゲットにしているか？」を十分に考慮して、目的に合わせたものを選びましょう。

 

よくある落とし穴…

  • 保存形式が
    統一されておらず、
    規格がバラバラ・・・

  • Wordで一旦
    作成してしまうと、
    他の形式に移行し辛い・・・

  • 更新頻度がバラバラで、
    バージョンの管理が
    できない・・・

  • 開発者が片手間で
    作成するため、
    資産化できていない・・・

開発者にとって親和性の高い環境とは？

  • １．Markdownなどオープンな規格を使う

    ドキュメントだけが、別のプラットフォームで管理されるなら、非常に手間がかかります。ドキュメントもコードと同じように、管理・運用が必要であると考えます。
    一方で、Markdownなど、オープンな規格を使い、Githhub上でドキュメントを管理することで、大幅に管理工数を削減することが出来ます。

    “オープンな規格”の特徴

  • ２．ヘッドレスCMSで更新し、
    様々なデータ形式に対応

    特定の編集環境に依存すると、ドキュメントを資産化することは難しくなりますが、ヘッドレスCMSを活用した、オープンなデータ形式（JSON）にエクスポートできる編集環境で、ドキュメントを作成することで、用途に応じて自在に展開できます。

    ヘッドレスCMS＋Jamstackの特徴
×

オープンな規格の特徴
① GitHub/Markdown/AsciiDoc

  • ■ 更新履歴が見える化できる
  • ■ 簡潔な記法で入力が容易になるように設計された軽量マークアップ言語を使用できる
  • ■ 開発者色が強い（コマンド、黒画面）
  • ■ マークダウンの記法を使って、コードブロックを書くのも知識が求められる
  • ■ わかっている人がいなくなると、引継ぎが難しい
×

ヘッドレスCMSを使用したJamstackの特徴
② Jamstack

  • ■ JSON形式でエクスポートできる。他のヘッドレスCMSでもインポートできる
  • ■ 更新履歴が見える化できる
  • ■ 開発者だけでなく、一般ユーザにもなじみやすい
  • ■ 導入後自分たちで拡張、メンテナンスできる
  • ■ ツールとしての完成度、速さ、パフォーマンス性の高さがある
  • ■ ヘッドレスCMSの場合、WYSIWYGでコードブロック編集も容易

開発者フレンドリーな
ドキュメント環境構築なら
ヒューマンサイエンスへ

ヒューマンサイエンスは、1985年以来、IT業界を中心に243社、3,148件の豊富なマニュアル制作実績。
IT企業に精通した技術力で、貴社に最適なドキュメントソリューションをご提案いたします。

実績豊富な
Bejamas社と連携

Jamstackでのサイト構築に数多くの実績がある、ポーランドのBejamas社と提携して開発します。

隅々まで行き届いた
サポート

バイリンガルのエンジニアが担当
開発の全工程をバイリンガルのエンジニアが担当することで、開発作業をスムーズに進行します。
サイト制作のノウハウを最大限に駆使
ヒューマンサイエンスには、これまでに多くのサイト制作をお手伝いしてきた実績があります。

 

 

IT企業向けドキュメントソリューションのご紹介

IT企業におけるドキュメントソリューションに求められるポイントとは？プラットフォーム選定のポイントや開発者にとって親和性の高いドキュメント作成環境をご紹介します。

 

 

【主な内容】

  • ドキュメントプラットフォーム選定とは？
  • プラットフォーム選定に必要な観点
  • 開発者向けドキュメントに求められる３つのポイント
  • ドキュメントを資産化する～開発者にとって親和性のあるドキュメント作成環境とは？
  • まとめ

ダウンロードはこちら

お問い合わせ・資料請求