情報システムの運用手順書についておたずねいたします。

弊社は小規模なソフト開発事業を行っておりますが、顧客側の要望により開発が完了したアプリケーションをデータセンターで運用することになりました。

それにともないデータセンター側に対し、開発したアプリケーションの運用手順書または運用設計書などと呼ばれるドキュメントを納品する必要が生じております。

しかし弊社ではそのようなドキュメントを作成した経験が無いため、ひな形やサンプルが掲載されているページを探しております。

実際には運用手順書または運用設計書はデータセンター側で作成することになるため、そのため元資料としてアプリケーションの運用説明書を提示することになります。

概ねエラーが発生した場合の対処法や、ログ出力などに関する解説を行うべきかと考えております。

このようなひな形やサンプルに関する情報を御提供願います。

HPへのリンク情報ではなく、実際に使われている運用手順書または運用設計書そのもの(機密情報は削除して頂いて結構です)を御提供いただいても結構です。その場合は別途お礼を致しますので御相談下さい。

宜しくお願い致します。

回答の条件
  • 1人3回まで
  • 登録:2008/03/26 13:36:27
  • 終了:2008/04/02 13:40:02

回答(3件)

id:felix33jp No.1

felix33jp回答回数484ベストアンサー獲得回数32008/03/27 00:41:08

ポイント27pt

なんのシステムですか?ひな形といっても漠然ひな形では探しようもない。

id:masyuta No.2

masyuta回答回数61ベストアンサー獲得回数32008/03/27 11:12:04

ポイント26pt

参考程度なのでポイント不要です。

 

普段からシステム管理で業務マニュアルやら作っていますので

構築の際のアドバイス程度で。

 

まず、一般の(通常の)システム運用プロセスフロー図(概要)を作成し、

それを目次ページとします。

目次なので、そのプロセスの詳細が書いてあるページを

忘れずに明記してください。

 

但し、マニュアルもプラグラムも同じで、ベースを構築した後に

追加や修正や削除が付いて回りますので、ページはP1・P2・P3・・・

という風に順番に構築せずに、プロセス毎に文字列を割り当てて、

その下にページを付加すると、後の編集・修正に便利です。

(M-1、M-2、M-3.B-1、B-2・・・といった風に)

 

次に詳細ページでは、出来るだけフロー図で処理を表してください。

文章・文字列だけで作成すると 非常に分かりにくくなります。

その際に、実際にプロセス上で表示される画面をSSで切り取って

添付すると、より分かりやすくなります。

 

そして、詳細ページで、そのプロセスで発生する可能性のあるエラーの対処ページ

別途追加してゆきます。

エラーの対処ページに関しても、フロー図が良いでしょう。

 

基本的に、この流れで良いと思います。

マニュアルは、読む側が「必要な時に必要な個所を早く理解させる」事が

重要であって、法律書や論文のような緻密さや重厚さは不要です。

それに設問を拝見する限り、「データセンター」で再構築されるとの事ですから

あまり細かく作り過ぎても、お互いに大変な目に会うだけだと思います。

  

どのみち、どのようなマニュアルを作成しようが、使い手からの

要求で、その都度の回答&編集が必要になるのはマニュアルの定めですらw

 

最後の注意点としては

「語句を出来る限り省略しない」という事です。

例えば、エラー時にモニタに「CF-032のエラーが発生した可能性があります

という表示が出る場合の処置を説明するのであれば

「"CF-032のエラーが発生した可能性があります"と表示された場合の処置」

と表記する事です。

これを「CF-032処置」とか「032発生処置」などと表記すると

使い手が間違った処置をしたり、たどり着けなかったりする事があります。

面倒かもしれませんが、これには注意した方が良いです。

 

長々となりましたw

マニュアル作成はなかなか大変ですが、頑張ってください。

id:ken33jp No.3

ken33jp回答回数928ベストアンサー獲得回数132008/03/27 10:43:45

ポイント27pt

データセンター側がテンプレート(文書フォーマット)とかサンプルみたいなものを

持ってると思いますので、普通は提示してくれますよ。

>概ねエラーが発生した場合の対処法や、ログ出力などに関する解説を行うべきかと

>考えております。

具体的に何がほしいのか相手に聞いたほうが早いと思いますよ。

作ったことがある会社でも、データセンターによって要求される内容が違いますので

普通は聞くと思います。

コメントはまだありません

この質問への反応(ブックマークコメント)

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません