ノウハウ
運用
仕様書
保守

社内wikiをフル活用したら、脳筋を脱却した話

More than 1 year has passed since last update.

はじめに

※この記事は偏見と若干のフィクションで構成されています。

体育会系エンジニアは脳筋だ(偏見)。
少なくとも自分は「気合で何とかなるだろう」「詰んでからが本番」と考える性分のため、いつも納期ギリギリだ。
そんなやつが保守・運用を任されるとどうなるか。

「この仕様どうなってるの~?」
(ソースを見る)
「これバグ?仕様??」
(ソースを見る)
「これ、出来る?」
(以下略)

今回はそんな日々が少しでも楽になったお話です。

前提

ウェブアプリケーションを開発しているが、とにかくアップデートの回数が多い。
またシステムとして未熟であることから、仕様書もできていない。アップデートに仕様書が追い付いていない。

システム創始者が一度作ろうとしたが、アップデートの回数が多すぎて、1か月後にはすでに別物のように見えるとのこと(ちなみにそれに気づいた瞬間にあきらめたらしい)。

そして闇が多い(ボソッ

そんなんだから、社内では
「仕様書などない」
「作成者が仕様書」
「仕様?ソース見た??」
等といわれる始末。属人化の権化みたいなシステムである。

やったこと

「質問をすべて社内wikiに書き留める」

ただこれだけ。書き方としては

  • 質問への回答だけでなく、仕様も記載する。
  • ソースがどこに書いてあるかをできるだけ細かく書く
  • カテゴライズをする
  • 導線は1つ(または同一のもの)

ぐらいは気を付けた。

結果

質問量は圧倒的に減った。
実測はしてないが、

やる前:最低でも6~7件/週、多い時には3~4件が同時に来ることも
今:週で3~4件、多くても5件

と半分近くまで減ったように感じる。

また該当ソースの場所が書いてあるので、
「このボタンをクリックすると、これが関数が動いて、ここで分岐してて、、、」
みたいな面倒な確認がいらず、時間短縮にもつながった。

あと質問が来ても同じものなら、
「お前はここでも確認しておけぇ~い!」
とコンサルさんにURLを投げるだけでオッケイ!これも時間短縮!!

自分の持ち駒を増やすことが重要だなぁと思いつつ、最近はこの社内wikiが仕様書になることを願ってやまない。

今では空いた時間を更なる筋トレに費やし、脳筋に磨きをかけている(本末転倒)。