メンテナンス手順書の作成を楽にした工夫


今週の担当は坂本です。先日、Nintendo Switchのスーパーマリオブラザーズを買いました。今までファミコン、DS、Wiiではスーパーマリオブラザーズをして遊んでいたので、懐かしさもあり楽しかったです!Wii版と操作が似ているため手が勝手に覚えていて驚きました。

さて、今日はサーバーなどのメンテナンス手順書の作成・管理をちょっと工夫して楽になったお話をしようと思います。

メンテナンス手順書の作成

当社で管理しているサーバーのメンテナンス作業を行なっています。自分が関わるメンテナンス作業の実施のために手順書を作成し、一緒に作業する上席者にレビューを依頼しています。

メンテナンス作業をスムーズに作業を行うためと、作業の記録として手順書を作成しています。

手順書の作成を楽に!


手順書の例

実際の手順書は500行くらいありますが、作成を少しでも楽にできるように以下2つの工夫をしました。

1つ目: 手順書をテンプレート化
2つ目: GitHubで手順書を管理

1つ目: 手順書をテンプレート化

今までは過去の手順書を参考にコピーなどをして日付や対象サーバー、コマンドを修正するようにしていましたが、変更漏れなどが度々あったことからテンプレート化することにしました。

メンテナンスの手順は毎回同じではありませんが、流れが同じものは手順書のテンプレートを作っておくことで、テンプレートをコピーして一部の内容を書き換えるだけにするという流れにしました。

今まで変更漏れが起こっていた原因は、「変更するべき箇所が分かりづらい」ためでした。例えば以前の手順書をコピーして作成すると、そのまま「2022.04」などと書かれているため、変更することを見逃しがちです。

そのためテンプレートを作成する時に、次の「変更するべき箇所を明確にする」工夫を行いました。

統一

具体的な値だと変更することがぱっと見でわからりづらいため、yyyy.mm などで統一しています。統一することで、検索をかけて一括変更することもでき便利になりました。

日本語で表記

テンプレート内で書き換えるIPアドレスも、具体的に数値ではなく"[サーバーIPアドレス]" として、何に変更するかを明確にするようにしています。また、コマンドの中に日本語が含まれている"違和感"を作ることで、変更漏れがあった場合でもレビューの際に気が付きやすくなりました。


日本語を含めることで変更箇所がわかりやすくなった

○や☆などの記号を使う

先ほど紹介した"コマンドの中に日本語が含まれている違和感" に似ていますが、文章の中に "○" などの記号を含めることで、違和感を作り変更する箇所であることを明確にしました。


〇〇の中はサーバーの種類を記載する

2つ目: GitHubで手順書を管理

レビューの依頼や修正を簡単にできるようにGitHubを利用することにしました。年、月単位でディレクトリを分けることで過去の手順書をすぐに参照できるようになりました。

プルリクエストでレビュー依頼

新しい手順書を作成する時にブランチを分け、レビューをプルリクエストで依頼することで、行数を指定しなくても直接コメントを書くことができます。変更点もすぐにわかるようになりました。また、「なぜそのように変更したのか」の経緯が残るのも今後見直す際、参考にできるため嬉しいポイントです。


プルリクエストのレビュー(Github)

今後

ちょうど先週GitHub上での管理を始めたところです。今後、他にも楽になる工夫を見つけたら話し合ったり実際に試してみながら、より効率良く仕事ができるようにしていきたいと思っています。

My Redmine

こちらの記事もオススメです!
ファーエンドテクノロジーに入社しました
黒谷と申します。2022年4月に入社しました。
チケットの作成時間を短縮!RedmineのCSVインポート機能はやっぱり便利
RedmineのCSVインポートの機能でチケットの作成時間を短縮。タスク漏れ防止にもなりました。
ウェブ・セキュリティ基礎試験(徳丸基礎試験)に合格しました
ウェブ・セキュリティ基礎試験(徳丸基礎試験)に向けてやった勉強内容を紹介します。
iPhoneを売ってみた
iPhone 7 32GBをメルカリで販売しました。
開発グループ マネージャーが入社してから3年半でやってきたことのふりかえり
仕事の背景、やったこと、利用サービス、感想の紹介など2018年11月以降の3年半の振り返りです。
ファーエンドテクノロジーからのお知らせ(2022/06/15更新)
RedMica 2.1 バージョンアップのお知らせ
My Redmineで提供しているソフトウェアをRedMica(ファーエンドテクノロジー版Redmine) 2.0 から 2.1 へバージョンアップいたします。
プロジェクト管理ツール「RedMica」バージョン 2.1.0をリリース Redmine互換のオープンソースソフトウェア
今日使える明日のRedmine「RedMica」の最新バージョン2.1.0をリリースしました。次期バージョン Redmine 5.1の新機能を先行利用できます。
月例Redmineセミナー「Redmine利用事例紹介 株式会社イシダテック様」【2022/7/7開催】
「Redmineでゼロから始めたプロジェクト管理〜製造業でRedmineを使いこなすための勘所〜」株式会社イシダテック様。Redmineをどのように業務で活用しているのか企業様の事例をご紹介します。
APPS JAPAN 2022(6/15〜17開催) にRedmineのブースを出展
6月15日〜17日に幕張メッセで開催される「APPS JAPAN 2022」にプロジェクト管理のオープンソース「Redmine」と「RedMica」、Redmineのクラウド版「My Redmine」などを紹介するブースを出展します。
Redmineの最新情報をメールでお知らせする「Redmine News」配信中
新バージョンやセキュリティ修正のリリース情報、そのほか最新情報を迅速にお届け