文書品質改善と現場対応をマネージャ視点で考える ―― 「良いドキュメント」の効用と現場の経験談を共有

冨岡 理

 皆さんは,「システム開発文書品質研究会(略称:ASDoQ,アスドックと発音)」という団体をご存じでしょうか.2011年6月にET Westで設立を発表し,7月に設立総会を開催した,名古屋地区を中心に活動の輪を広げている任意団体です.Tech Villageの読者の方々には,全6回で連載された「理系のための文書作成術」の筆者である塩谷 敦子 氏が幹事に名を連ねる団体と言った方が分かりやすいかもしれません.

 この連載の第5回でしたでしょうか,「設計者をレビューしていませんか?」の一言に,ドキッとしました.筆者にとっては塩谷氏の連載は目からうろこの連続で,文章の細部への目の配り方,記録の残し方,レビューのあり方など,「よいソース・コードさえ出来上がればよい」と,心のどこかで甘えていたことをあぶりだされた気分になりました.

 「良いソース・コードさえ出来上がれば,ドキュメントはそれなりでもよい」では,因果関係が全く逆なのですね.良いドキュメントが良いソース・コードにつながるということなのでしょう.こう書いてしまうと当たり前のことのようですが,現実としては,納期と仕様変更に追われるわが社の技術陣も,文書の推敲(すいこう)にかける時間はなかなか十分には取れていません.

 なぜかこの人の文書は読みやすい,反対にこの人の文書はどうも読解に集中力を必要とする....読み手としてはその違いに気づきながら,技術の内容とは直接関係のない文章そのものについて,いい大人に対して指摘するということを遠慮する気持ちもあるはずです.筆者にはあります.

 

●レビューで修正方針を決定,さて記録は残っている?

 そもそもシステム開発プロセスにおいて成果物として残るのは,ソース・コードとドキュメントです.要求仕様書に始まり,システム設計,ソフトウェア詳細設計,テスト仕様書やテスト報告書まで,各フェ―ズにドキュメントが残るはずです.これだけあるドキュメントに対して,定量的な品質基準がないことの問題の大きさに気づいている人がどれだけいるでしょうか.

 私たちは常日ごろソース・コードの品質を上げようといろいろと苦労しているわけですが,レビューはまさにその現場中の現場です.設計段階では仕様書や設計書,テスト段階ではソース・コードやテスト結果の文書をレビューしていきますが,若手技術者にとってはドキドキの場面ですよね.プロジェクト・リーダや同僚,最近では別プロジェクトの第三者や品質管理担当が同席する場合も多いでしょう.びしびしと厳しい指摘がなされ,議論になることも少なくありません.そして最終的に修正方針が決められ,簡単なものであればその場で修正することもあると思います.

 さあ,この一連の議論や修正は記録に残るのでしょうか? 2年後の開発でこのモジュールを流用する際に,「なんでこうなってるんだっけ?」と悩んでしまう経験は多くの人が持っているはずです.

 

●現場に受け入れられる品質改善を考える

 筆者が所属している社団法人組込みシステム技術協会(略称:JASA)は,組み込みシステムで事業を行っている会社を中心に,200社ほどで活動している業界団体です.年に1回,パシフィコ横浜で開催される「Embedded Technology展」(ET)を主催しているほか,組み込みシステム業界の技術の向上と啓蒙のために研究会やセミナを実施しています.最近ではさまざまな問題を反映してか,品質に関するセミナを開催する機会が多くなる傾向にあります.

 このたびJASA 技術セミナー委員会では「文書品質」に着目したセミナを企画しました.文書品質は,とても重要なことであるにもかかわらず,見落とされがち,誤解されがちなテーマだと感じています.

 今回のセミナの講演は,冒頭に挙げたASDoQ 代表幹事でもある名古屋大学の山本 雅基 氏にお願いしました.電話で依頼しながら,連載記事「理系のための文書作成術」を読んだ筆者の感想も伝えつつ,こちらのセミナでは,連載記事とは対象を若干変えていただけるようにお願いしました.

 塩谷氏の連載に痛いところを突かれている開発者は多いはずです.逆に「その通りだ」と大いに意を強くしているのは,マネージャや品質管理部門,プロセス改善を推進している方々ではないでしょうか.こういった方々を対象に講演してください,とお願いしたのです.

 プロセス改善全般に言えることですが,改善活動を推進する側と改善によって業務の変更を強いられる側は,多くの場合,対立します.総論では同意しても,各論に入るとうまくいきません.現場側にしてみれば,(はっきりとは言いませんが)「大きなお世話だ」というわけです.確かに改善活動を推進する側に杓子定規なところがある場合も多いのでしょう.

 これまでのJASA技術セミナーでも,手法そのものの話より,実際の導入事例,もっというと現場からの抵抗の経験談が受講者の方々にとって情報の宝庫になっています.「ああ,みんなここで反発を受けるんだ」,「それを乗り越えるにはそうすればいいんだ」と「共感」できることが,良いセミナの必須条件だと考えています.

 今回開催するセミナでは,能動的に開発文書に取り組むと,品質改善にとどまらず人材育成にも良いことがありますよ...という内容になる予定です.さまざまな立場の方に,多少でも変わっていくきっかけにしていただけると幸いです.

 

第27回 JASA ETセミナー
開発文書の新時代 ~文書品質を上げて開発力アップ~

日時:2011年11月8日(火) 13:30~17:30
会場:東実年金会館(東京都中央区日本橋浜町)
プログラム:
「ソフトウェア開発文書が育てる経営者と技術者」 名古屋大学 山本 雅基 氏
「文書診断で開発品質を向上させる」 合同会社イオタクラフト 塩谷 敦子 氏
受講料:一般 8,000円 /JASA会員 6,000円(税込,テキスト代を含む)

詳細の内容およびお申し込みは,JASAのWebサイトからお願いいたします.
http://www.jasa.or.jp/top/activity/jevent/66th_detail.html

 

 

とみおか・おさむ
東電ユークエスト(株)
JASA 技術セミナー委員会 委員長代理

 

 

組み込みキャッチアップ

お知らせ 一覧を見る

電子書籍の最新刊! FPGAマガジン No.12『ARMコアFPGA×Linux初体験』好評発売中

FPGAマガジン No.11『性能UP! アルゴリズム×手仕上げHDL』好評発売中! PDF版もあります

PICK UP用語

EV(電気自動車)

関連記事

EnOcean

関連記事

Android

関連記事

ニュース 一覧を見る
Tech Villageブログ

渡辺のぼるのロボコン・プロモータ日記

2年ぶりのブログ更新w

2016年10月 9日

Hamana Project

Hamana-8最終打ち上げ報告(その2)

2012年6月26日