【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
生まれてこなければよかった少年
今日通勤中、小学校中学年？くらいの少年とお母さんの電車の中での会話。 少年「ねえ、なんで勉強しないといけないのかなぁ。僕勉強嫌いだよ」 母親「勉強がんばったほうが、大人になった時にいっぱいやりたいことができるよ」 少年「でもぼく、頑張るのは嫌なんだ。どうしても頑張らなきゃだめなの？」 母親「今はお勉強頑張らなきゃだけど、○○君が大人になったらお仕事をして○○君が頑張っただけお金ももらえて、美味しいごはんとか好きなものとか買ったりできるんだよー。」 少年「そっかぁ、こどもも大人も頑張らないとなのかぁ。ぼく頑張りたくないなぁ。生まれてこなければよかったなぁ」 生まれた意味とかあんまり考えず、お仕事が終わったあとにコンビニであたりめと男梅サワーを買って帰って 家でゲームしながら飲んでるだけで幸せな自分には、いろんな意味で考えさせられる会話でした。
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
