更新日: 2011-06-10 16:36:04

手順書の書き方のコツ

著者: 読書マン

編集者: airiiiii

閲覧数: 1237

Okgn btn gudie info favorite

0

関連タグ:

はじめに

Photo by 読書マン

職業柄、サーバ構築の手順書などを作成している方は少なくないでしょう。
そこで国語力がない方でも手順書が書けるコツを紹介します。

STEP1

手順書の書き方というのは何のためのものなのか、あるいはGUIかCUIかでも変わってくるのではないでしょうか。 基本的に人間が参照するためのものなので、自分=人間が判れば良いという程度のものです。

STEP2

すべてコマンドラインでの操作ですし。 具体的には、テキストファイルに実際の操作を順に書き連ねています。 # tar zxvf foobar.ta.gz とかですね。 上から順に実行していけば同じ構成を再現できるように、というのが基本的なコンセプトです。

STEP3

もちろんそれだけでは何のための作業なのか判り難い部分もありますので、それぞれの操作に注釈をつけています。 そのような手順書を、OSインストール用、Apacheインストール用、というような感じで個別に作成しています。

STEP4

それらとは別に、稼動するサービスの概要、ポリシー等を文章で説明したファイルも残してあります。 これらをマシンごとのフォルダにまとめています。 コマンドラインで作業をする分にはこの程度で充分ですね。 また、ただのテキストなので実際にその手順を実行する場合は、各操作をコピぺで実行できますし。

まとめ

どうでしたか?これであなたも手順書がかけますよ。

【PR】

このガイドは役に立ちましたか?ガイドの著者にお礼を伝えよう!

Okgn btn gudie info thunks b

26

関連タグ:

当ガイドは作成日時点での情報です。ガイド内容の実施はご自身の責任の元、ご利用いただきますようお願いいたします。

このガイドを通報する

著者名:
読書マン

読書マンです。

マンといいながら、実は主婦してます。

夫には内緒です。