【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
インフラエンジニアのための本を執筆しました＆執筆環境を紹介します | 株式会社ヌーラボ(Nulab inc.)
本の中の似顔絵が似ているので、社内チャットのアイコンもこれにしたらどう？と言われた中村です、こんにちは。 「現場のインフラ屋が教える インフラエンジニアになるための教科書」という本を執筆してて、つい先日（2016年6月24日）発売となったので、簡単にその内容と執筆環境の裏側を紹介します。 書籍の紹介 メインターゲットは、2〜3年目のインフラエンジニアです。仕事にもちょっと慣れてきて余裕も出てきた頃に、今後生き残るために何をどうしていくかの指針となるような本です。 その中で、私は「第6章 DevOps時代に求められるスキル」を担当しました。 6.1 インフラエンジニアを取り巻く環境 6.2 Infrastructure as Code（コードとしてのインフラ） 6.3 システム開発における3つのプラクティス 6.4 DevOpsを支えるプラクティス・ツール 私はもともとアプリエンジニアなので
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
