手順書を書くときに気をつけていること | DevelopersIO
最近、たまに調理器具などが行方不明になっているかめです。 子どもの世話などをしている時に、パパが洗い物をしてくれる機会が増えたので、私にとっての定位置とは違うところに遊びに行っているようです。 複数人で何かをする時には、認識合わせが重要ですね。 はじめに 手順書といえば、弊社には植木さんという神がいて、 【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO なんて神記事もあります。 二番煎じのようで恐縮なのですが、産休から復帰してチーム内の手順書を眺めて見たところ、複数人で更新しているため、それぞれの気をつけているポイントが違い、なんだかキマイラのような手順書に進化していたので、まずは、私が気をつけているポイントを発信して、チームとしてみんなで気をつけるポイントを相談してみようかなーと思い、この記事を書くことにしました。 せっかくだから、大変になりす
【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
