さとまも談義|テクノロジーと体験とアートと

テクノロジーとビジネスと人の関係性にずっと興味があります。アートやダイバーシティのキーワードも含めて、世界がどう変わっていくか、変えていけるかをお酒を飲みつつ考えるブログ

伝わるドキュメントを書く(ITアーキテクトより)

現在、社内にて「ドキュメント作成の効率化」という小規模な勉強会を開催しているのですが、
それにちょうど良さそうな記事をITアーキテクト(Vol.23)という雑誌で発見しました。

勉強会にて、課題として捉えているのが、主に以下の4つなのですが、3つめに合致していると言えます。

・ドキュメント作成効率化の不徹底
・ドキュメントの管理手法の未熟さ
・ドキュメント記述能力の未熟さ
・社内でのノウハウ共有不足


多くのシステムエンジニアにとって、ドキュメント作成は重要であることは理解しているが、あまり気が進まない、あるいは漠然と処理してしまっている分野だと言えます(自分も含めて)。

このような場当たり的な文書作成を繰り返すことで、コミュニケーション不足が解決できなかったり、後続フェーズへの情報伝達に不具合が発生したり、保守作業にてドキュメントを読み返した際に意味不明になっていたり、ということが往々にして起こっています。

誰かが気づいて反省するか、お金がかかって痛い目に遭うと、プロジェクト内では改善されることもあるようですが、大半は反省だけして終わってしまっているような印象があります。

皆さんの会社やプロジェクトではいかがでしょうか?
ドキュメントはきちんと管理されていますか? 
分かりやすい日本語で、必要な情報が記載されているでしょうか?


さて、記事の中では、伝わらない文章の原因は以下の4つであると述べています。

・知識のギャップ
・目的のギャップ
・手法のギャップ
・熟練のギャップ


ブログで記事をコピペするのが目的ではありませんので、内容については説明しませんが、
なるほど当たり前なことばかりです。
とはいえ、こういう「当たり前じゃん」みたいな思考が、知識のギャップを生んでしまう原因の一つなので、
要注意だとは思いますが。


うちの会社に限らず、けっこうおかしな文章が書かれている世の中です。
みなさんも文章を伝わるように書く、ということにもう少し意識を向けてみても良いのではないでしょうか?


興味のある方は、ぜひITアーキテクトをご参照ください。
(別に宣伝ではありません。あしからず)

                                                                                                                                                • -

あと、「なんちゃってPMの生態を探る」という記事も個人的にはツボでした。

弊社の場合、立場上のせいなのか、こういう人もけっこういるんじゃないかと想像してます。
幸い、私が直接お世話になっているPMさんは、みんな優秀で本物のPMさんなのですが。
あくまで想像ということで。

分類のなかに、「寝技型なんちゃてPM」と「形式主義なんちゃってPM」という分類が出てきます。
これも実に的を射ていると言えます。

現場にいると、寝技型の人は世知辛いお金の事情との板挟みになり、なかなかロジカルに事を運ぶことが難しくなっているように思います。

あと、たいていはお金のことや社内のうんたらに対応するPMと、現場の管理をするPMと二役があることが多そうです。世の中でこれだけ普及しているんだから、そもそもロールを変更すべきなのかもしれません。

一口にPMと言っても、やっている仕事は様々というのが現状ですね。