オンラインマニュアルを構築する方法を検討してみた

2018年7月19日パソコン関連Sphinx,WordPress,パソコン関連

タイトル通りですが、オンラインマニュアルを構築する方法を検討してみました。

WordPressやwiki、静的ページやteachme等を実際に試してみて、どんな用途向けに使えそうか、またデメリットは何があるか、を検討してみました。

お仕事絡みのメモ的なものです。

スポンサーリンク

やりたい事

ざっくりまとめるとこの3点に絞られます。

  • マニュアルサイトの構築
  • 指定ユーザー以外は閲覧出来ない様にしたい
  • 社外からでも、どこからでも修正できる様にしたい

一応現在はこの目的に対してSphinxを使ってHTMLを作成、会社所有のサーバーにアップロードしてBasic認証を行う形で対応出来ています。

これは「指定ユーザー以外は閲覧できない様にしたい」という目的を最優先させた事と、適当なサーバーが空いて無くて静的ページ置く位しか出来なかった事が理由です。

ただマークアップなんで覚えなきゃ行けないし、書くの面倒な所もあるしリアルタイムで修正確認できないしと不満は多い。

さらにエンコードするのに環境整えないといけないのが一番面倒くさい。さらに元ファイルを更新したらエンコードしてアップロードして表示確認、っていつの時代だ。

もうそういう所から解放されたいんです。

teachme

テストもしてみたのですがかなりいいと思います。「この時はこうする」等の手順として明確になっているものについては最適でしょう。

編集も画像をドラッグ&ドロップ出来るし、センテンス毎にステップを細かく書きやすいです。例えばハードセットアップとかの定型的な特定操作を説明するならすごく便利だと思います。

ですが設定画面を説明する様な、例えばWindowsだとコントロールパネルそんものの説明の様な「ここをこうするとコレが出来る」という形の機能を説明するマニュアルは作りにくいと思います。

そして私が求めているのはその機能を説明するマニュアルなので合わない、という結論になりました。

Wordpress

次は実際に使っており、自由度も高いWordPressを調べてみました。

WordPress

固定ページにリンクを作って閲覧可能な形に出来るのでマニュアルを作るのにも向いている気がします。

でもテーマはブログやメディア的な物が多く、マニュアルに向いている様なテーマが見つけられませんでした。デザインは自分で頑張る気力は全くありません。

さらにどうしてもついて回るメンテナンス。引き継ぎ等も考えると問題になりそうなので結局は除外としました。

(2018/12/18追記)
バージョン5以降では当時と異なりエディターがGutenbergになりました。

画像のドラッグアンドドロップに対応した事もあり個人的にはかなり気に入っている編集環境です。

なのでよさそうなテーマがあればWordPressが一番いいかもしれません。

Wiki

最後はある意味マニュアル的なゲームのまとめサイト等でよく使われるwikiがいいのかな、と思って再度調べてみました。

実はShpinxを使う前にもWikiを検討したのですが、閲覧制限がかけられないので断念した経緯がありますが、改めて調べたらpukiwikiでbasic認証出来る事を確認できました。

ただ画像を多用するには記述や別途アップロードが必要等、手間がかかるのが難点ですが元々の目的はすべてクリアできます。

なので一番都合良さそうなのはwikiではないか、と考えています。

おわりに

なんですが今更大前提の「稼働させるサーバーやドメインをどうするか」いう問題が出てきました。

AWSでもどこでもいいんですが、コスト的には全く見合わないので許可は出ないでしょう。

それに今稼働中のサーバーへインストールするにもOSが古い等色々あって手が出せません。

そうすると結局は今のsphinxでやっていくのが一番良さそうな感じになってしまいました。

下手の考え休むに似たり、とはこの事です。

(2018/12/18追記)
今はAWSでWordpressのサーバー立てて、ドメインはサブドメインを設定できそうな解決策が見えています。後はテーマだけですね。

スポンサーリンク

2018年7月19日パソコン関連Sphinx,WordPress,パソコン関連

Posted by たーさん