【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
Macを購入したら最初に設定しておきたいシステム環境設定
@おったんです。システム環境設定は、Macを快適に利用するために欠かせないもの。とくに、Macを最近購入したという方々のご参考になればと思い、現在の私のMacBook Proの設定をまとめてみました。 システム環境設定 システム環境設定の中で、カスタマイズしている項目のみを抜粋してご紹介します。変更していないものは割愛しています。 一般 macOS標準のテキストエディットを使用する場合に、ファイルを更新した覚えがないのに、ファイルを開いたら前回の編集内容が反映されてしまっていた、なんて覚えはありませんか？これは、macOSのオートセーブ機能が働いているためです。 便利そうな機能なのですが、編集前の状態に戻したい場合には不便です。オートセーブ機能を無効にするためには、「書類を閉じるときに変更内容を保持するかどうかを確認」をチェックします。 一見すると、矛盾しているようですが、これは、オフにし
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
