SEの現場で文書整備がいつまで経っても出来ない理由 つづき
🔷文書整備がうまくいかない原因②
「人によって文書の
あるべき姿がバラバラ」
例えば、
設計文書であれば、
「システムの機能について書く」
会議の議事録であれば
「会議で何を話し合ったかについて書く」
といったように、
文書の目的が「解説」や「記録」といったように
はっきりとしている。
それでも、文書のあるべき姿について
いざ話し合ったりすると、
意見が全く合わない時があります。
どう合わないかと言うと
「そもそも、
どこまで記載すべきか?」
という点です。
あれこもこれも書いてたら、
すぐにその文書はごちゃごちゃになっていく。
いくら綺麗に整理して書けたとしても
それで他の文書も様式を統一させようとしたら
それはそれでとても大変。
かといって、あまりにあっさりさせすぎたら、
そもそもの目的に応じたものにならないという
懸念も出てくる。
じゃあ、「最低限ここまでは書こう」なんて
話になったとしても、
人によって「最低限」の
レベルが異なるので
話がまとまるわけがないのです。
人によって異なるという意味は、
それぞれ趣味趣向、好みの違いがあるという事
ではなく、
知識、経験、対象のそのものへの理解度が
異なるという事です。
🔷文書整備で大事な事 その2
「誰のための文書なのか
を明確にする」
ふつうは、文書の様式を決める際、
書く内容やレイアウトについて話し合っても、
読み手に「誰」を想定しては書くか、
なんてところは検討しません。
なぜなら、その文書を利用する人は、
経験年数10年以上のベテランもいれば、
先月入ってきた新人さんもいるからです。
誰か一人に特定できない以上は、
「誰のため」ではなく、
「何のため」の文書かという話が
自然な流れであり、
読み手の想定などはしなくなります。
このせいで
「ここまで書かなくてもいいでしょ?」とか
「この書き方だとわからないんじゃない」という
明確な判断基準を持たないままの
モヤモヤした応酬が事あるごとに発生します。
そして最終的に書かれているレベルがバラバラの
文書群に出来上がっていきます。
こういった事態を回避するには、
やはり、どんな読み手を対象としているのか
前提をはっきり決めるしかありません。
ある程度のベテランを想定するなら
本当に必要最低限の記載で構いません。
しかし、そういった文書のみでは、
新規参画者が仕事を一人でやっていくには、
かなり厳しいです。
誰かが、文書でカバーできない部分を
補填してあげるつもりでいなければなりません。
新規参画者を想定するなら、
その対象について、それが出来た背景、
そもそもの目的など、前提となる部分について
しっかり記載する必要があります。
なぜなら、新しく来る人にとっては、
これまでの経緯などは、誰かが教えない限り
わかりようがないからです。
メンテナンスの手間が掛からないのは、
ベテラン向けドキュメントですが、
そこに記載されない口伝えの情報や、
誰かの頭の中にだけある知識は、
いずれ消えたり、一部が欠落したりするものです。
個人的には、ちゃんと文章にして残していくことを
お勧めします。
🔷文書整備がうまくいかない原因③
文書整備がうまくいかない原因の3つめは
ドキュメント類を作った後の話です。
なんとか苦しい思いをしながらも、
新しい管理文書や設計文書を作ったのに、
それが満足に使われないまま
何も無かった頃に戻ってしまう時があります。
直接の原因はいたってシンプルで、
その新しい文書が知られてなかったり、
忘れさられてしまうからです。
では、なぜ新しい文書が
認知されないままになってしまうのか?
周りへの連絡、説明が足りてないというのは
もちろんそうなのですが、
「文書が出来た後のことまで
考えられていない」
事が、そもそもの原因です。
良い文書、ちゃんと考えて作られた文書ならば
みんなも普通に使い始めるだろうと思ったら
大間違い。
その文書が無くても、
なんとか済んでいたのが、これまでの状況です。
特にそれが無くても、古いものを使ったとしても、
誰も困らないのです。
🔷文書整備で大事な事 その3
「文書が放置されない
運用方法を考える」
新しい文書が放置されないようにするための方法は
基本的には、この一点!
「使わずにはいられない
状況を作ること」です。
理想的なのは、それを使用しないと
作業そのものを始められないという状況。
このほかだと、
例えば、誤って古い形式のものを使用した場合、
嫌でも間違いが目につくとか(他と比較される等)
承認者が、その文書を差戻すというような
ルールがあることです。
こういった状況やルールがあれば、
作業者は新しい文書に従わずにはいられません。
そして、みんなが常に最新の形式で、
その文書を使うことで、何か変更があった場合も
確実にアップデートされ、文書だけが
取り残されるような事はありません。
そこまで必要?と思うかもしれませんが、
①:文書が最新化されない →
②:不完全な文書として利用できなくなる →
③:困る人は自前の資料を持つようになる →
④:「正規」文書というもの自体がなくなる
過去に単発で作成した殆どのドキュメントは
この流れにのっかってしまい
誰からも見られることなく
化石として存在し続けます。
そして、新人はいつも必要な情報を、
設計書や手順書などから得られずに、
大変な苦労をするのです。
🔷最後に、ちょっとだけまとめ。
人の記憶には限界があります。
そして注意力についても同様です。
何かを考察する時は、頭の中だけで考えるよりも
書かれているものを見ながら考える方が
より効率的です。
文書類に対して、考えを改めて
しっかり作り、しっかり整備していけば
自分たちが思っていた以上の効果が絶対にあると
私は考えています。
関連する投稿
- 新人SEの不安と対策 (後編) PMBOKのリスクマネジメント
- 新人SEの不安と対策 (前編) 4つの不安
- 周りはいつだって「求む!説明上手のエンジニア」
- SEの現場で文書整備がいつまで経っても出来ない理由
- 先輩SEが教えてくれない?知識が引き継がれない負の連鎖
現在の記事: SEの現場で文書整備がいつまで経っても出来ない理由 つづき