手順書の書き方のコツ

質問

はじめましてyoshiと申します。

ＩＴ業界に入って約半年になります。

今、私はデータセンターでサーバ構築の手順書を作成しています。
そこで質問なのですが、私は国語力がない為、手順書の作成に時間がかかります。どのような単語を使えばいいのかわからなくて、迷ってしまいます。
多くの画像をキャプチャして作成する方法もありですか？（なるべく文章はかかない）
経験者の方アドバイスお願い致します。

回答No.4

tk_uc · ベストアンサー

手順書の書き方というのは何のためのものなのか、あるいはGUIかCUIかでも変わってくるのではないでしょうか。

私は幾度となくサーバー設定の手順書を書いてますが、専門教育は一切受けていないので一般的かどうかは判りませんし、基本的に障害発生時やマシンの買い替え時などに自分で参照するためのものなので、自分で判れば良いという程度のものです。
すべてコマンドラインでの操作ですし。

具体的には、テキストファイルに実際の操作を順に書き連ねています。
# tar zxvf foobar.ta.gz
とかですね。

上から順に実行していけば同じ構成を再現できるように、というのが基本的なコンセプトです。

もちろんそれだけでは何のための作業なのか判り難い部分もありますので、それぞれの操作に注釈をつけています。

そのような手順書を、OSインストール用、Apacheインストール用、というような感じで個別に作成しています。
それらとは別に、稼動するサービスの概要、ポリシー等を文章で説明したファイルも残してあります。
これらをマシンごとのフォルダにまとめています。

コマンドラインで作業をする分にはこの程度で充分ですね。
また、ただのテキストなので実際にその手順を実行する場合は、各操作をコピぺで実行できますし。

回答No.5

jazzkazz

> 多くの画像をキャプチャして作成する方法もありですか？（なるべく文章はかかない）
提示先の見る方々にどの程度、画面を見せる必要があるかにも寄ります。
また、なるべく文章を書かない方法をとるとかえって読む順番が判りづらくなる場合もありますので注意。

私が一般的にやるとしたら、
・最初に概要説明及び基本的な画面展開と簡単な画面解説。
・各画面展開に合わせた画像とその画像に置いての作業及び説明。
　（最初の画面解説にはこの各解説先のページをふる）
・重要事項は太字など目立つ様にする。
・サーバー構築ならコマンド一覧及び簡単な解説もあって良いかと。

回答No.3

jacta

サーバー構築の手順書は書いたことがありませんが、一般的な業務手順書を書いた経験は何度もあります。

> どのような単語を使えばいいのかわからなくて、迷ってしまいます。

どういう意味で言われているのか分かりませんが、あまり格好を付けずに分かりやすい言葉で書くのが、結局は一番良いと思います。
できれば、その職場でしか通用しない方言は避けるか、使うとしても用語の定義を明確にした方がよいでしょう。そうでないと、新人や転職者の理解の妨げになります。

他には、手順書の目的（何のための手順書か）と適用範囲（何に当てはまり、何に当てはまらないのか）を最初に明確にすれば、混乱が少なくて済みます。

回答No.2

umasikajiro

社内マニュアルなら作ったことが有りますが
私の場合はHTML形式で作りました
----------
　　タイトル
・手順1　　＜＝詳しい説明(画像つき)ページへのリンク
・手順2　　同上
・手順3　　同上
　#重要：セキュリティのため必ず＊＊＊＊を実施　＜＝これも別ページに詳しく書く
以下のページでは順を追って画像付の詳細な説明
--------
こうすると、スキルの高い人ならば項目だけである程度判りますし
良くわからない人は、詳細なページから読めば判るかと思います。
HTMLにしたのは勿論ペーパーレスの為ですが、結局は印刷されることが多かったようです

回答No.1

Zuchi

まず、職場の資料棚をあさって類似した書類などを読んでみてはいかがでしょう？用語というのは職場によって微妙に使われるものが違ったりするので、周囲に合わせてしまうのも良いと思います。画像の使用頻度にも同じ事がいえます。

私の職場では１操作１ページで画面のキャプチャーを貼って解説していました。間違いが起きなくていいんですが、印刷コスト高いんですよね（笑）