【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
弟子の育て方(OJTにおいて『教える側』として気をつけたこと) - ゆとりずむ
こんにちは、らくからちゃです。 先日、はてなブログ界隈をうろついていたら、中々面白げな記事を発見いたしました。 ■「メモを取れ」ほど非効率なものはない よくＯＪＴで「メモを取れ」という人がいる。私はいつもこれが理解できない。メモを取るほど重要なことならば、なんで教える側の人間が要点をまとめたメモを事前に作っておかないのか？自分の怠惰を押し付けているだけではないのか？メモをとることで意識が手先に移り、重要点を聞き逃す可能性は考えないのか。 そもそも、その仕事を教えられるほど熟知している人間と、何もわからない新人のどちらが重要なポイントを把握できるだろうか。初めて聞いた仕事内容で瞬時に重要なポイントを書き出せるスーパーマンはそんなに居ないと思う。 最初に言っておきますが、どんな仕事においても『ちゃんとメモをとること』は大切な技術です。お客様からの電話を受けるとき、打ち合わせで議事録を取るとき、
業務マニュアルTips
業務マニュアルの受託制作の経験を通して感じたことを、ここに書き連ねていこうと思います。 社内で、業務マニュアルや教材づくりを検討されている方のために、何かしらお役に立てれば幸いです。 業務マニュアルTipsについて 業務マニュアルの受託制作の経験を通して感じたことを、ここに書き連ねていこうと思います。 社内で、業務マニュアルや教材づくりを検討されている方のために、何かしらお役に立てれば幸いです。 マニュアルの作り方そのものについては、すでに良書がたくさんありますので、ここでは社内でマニュアルを作る場合の周辺のモロモロに焦点をあてることにします。 思いついたことからランダムに掲載していく予定です。忙しいとどうしても更新が滞りがちになるのですが、激励メールなどをいただけると、調子にのって更新するかもしれません（？）。 なお、ここでは「業務マニュアル」を次のように広くとらえています。 社外向けの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
