Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
1
Help us understand the problem. What is going on with this article?
@Anubis_369

手順書を書くための基本

手順書を書くときに気をつけること

  • スタートとゴールは一つ(条件分岐はしない)
  • やることは一つに絞る
  • 工程に見出しをつける

この三つを守ることで、読みやすい手順書が書けます。手順書は作業記録ではありません。自分のやった作業を箇条書きで書き出しても、手順書としては機能しません。

スタートとゴールを絞る

どういう状態からスタートして、どういう状態になればゴールなのかをハッキリさせてから手順書を書きましょう。スタートをハッキリさせないと、どういう条件で使用できる手順書を書きたいのか分からなくなります。ゴールを決めておかないと、何をするための手順書か分からなくなります。

スタートとゴールをハッキリさせておくと、手順書に対しての補足を書くことができるようになります。また、「もし○○であれば」のような、条件分岐を避けることができます。結果として、手順がはっきりとして、分かりやすい手順書が書けます。

やることを一つに絞る

書こうとしている手順が、ソフトウェアのセットアップなのか、設定なのか、それとも確認作業なのか、目的をはっきりさせましょう。例えば、調査をしながらソフトウェアのセットアップをしたとします。その時の手順をそのまま手順書に落とすと、どこが調査の手順なのか、どこがソフトウェアのセットアップの手順なのか、手順書を読んでも判断がつかなくなります。

同時に二つのことをやろうとすれば、その分、手順が複雑になり難易度が上がります。

工程に見出しをつける

手順を単に羅列しているだけでは、どのような作業をやっているのか分からなくなりやすいです。また、他のドキュメントと内容を関連付けたいときに見出しが役に立ちます。見出しをつけるだけでも、後から見直しがしやすくなりメンテナンス性が向上ます。

1
Help us understand the problem. What is going on with this article?
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Anubis_369
SESで働いているしがない火消しエンジニア。インフラ系の人。 よくOSCで登壇していたりする。所属団体は「劇団パワーシェル」。団員は一人。Powershellの話をよくやっている。

Comments

No comments
Sign up for free and join this conversation.
Sign Up
If you already have a Qiita account Login
1
Help us understand the problem. What is going on with this article?