理系のための文書作成術(6) ―― 仕事で文書を「書かされている」あなたへのメッセージ

塩谷 敦子

●文書の質から仕事の質へ

 このように,ドキュメンテーションが仕事の進め方を表し,成果である文書が仕事の成果を表せるならば,仕事の質は,文書の質として映し出されてくるのではないでしょうか.そして,仕事の質を測るために,文書に対する要件が提示できるのではないでしょうか.特に,目に見えにくいソフトウェア開発のような仕事の評価は,それぞれの作業を映し出している開発文書を評価することで見えてくるはずです.

 現在,筆者らは,開発文書を確認し,問題点を指摘し,改善に導くための「文書診断」を実際の開発の場に適用しながら,方法論を模索し研究しています(第4回第5回にて紹介).この「文書診断」では,文書内の表面的な表記や表現の改善だけでなく,開発作業自体の不備や問題を発見し.開発プロセスや最終成果物である製品の品質を上げるための方法を検討していきます.そして,「文書診断」を用いて,質の高い文書と製品を開発できる「人」を育てる活動にも,広げていこうとしています.

●文書は読み手のためならず(何のために文書を作るのか)

 最初の問いかけに戻りましょう.「なぜ文書を作るのでしょうか?」

 それは,文書を作ること(ドキュメンテーション)で仕事のプロセスや品質を可視化できるからです.可視化できれば,それを検証し,プロセスや品質をより良いものに向上させられるからです.

 では,「何のために文書を作るのでしょうか?」

 それは,自分が行った仕事そのものを示すためです.仕事を可視化して示し,良い仕事を行うためです.開発文書を書く理由を,「良い開発を行うため」にしませんか? 上司や品質保証部や納入先に提出するためだけでなく,レビューアに読んでもらうことや,文書を残すというルールを遵守するためだけでもなく.

 「良い開発文書を書くこと」は,「良い開発を行うこと」そのものです.これからは,自身の仕事と成長のために,文書を書いてみませんか.

***

 10カ月以上もの長い期間,この連載記事にお付き合いいただき,誠にありがとうございました.これまで15年近く「ソフトウェア・ドキュメンテーション」に携わってきて,ずっと変わらず主張してきた点を,今回見直す機会をいただきました.また,新たに追加したり補強できた考えも,少し整理するきっかけとなりました.今後も,皆さんが自信を持って仕事をし,それを反映する開発文書を嬉々として書き,ストレスなく元気に過ごしていくために役立つ,そんな「ドキュメンテーション」の提案を目指します.

 なお,このような取り組みと併行して筆者らは,開発文書の品質とは何か,品質が良いとはどうあることかを考える研究会「システム開発文書品質研究会(ASDoQ:アスドック)」を作ろうとしています.開発文書に限らず,広く文書に興味を持つ方々が,産学官それぞれの組織や環境から集まり,2011年7月に設立総会を開催します.

 読者の皆さんの中に,この連載記事を読んでくださって,文書作成に興味を持ち始めた方,これまで開発文書の作成を軽視していたが,その重要性を少しでも認識し始めたという方が一人でもいらっしゃれば,筆者はとても幸せです.そのような開発文書と開発作業に興味を持っていただける方に対して,開発文書の品質を測るための仕組みづくりの経過報告ができるよう活動を進めていきたいと思っています.いっしょに仕組みを作っていこう,または良い文書とは何かを一緒に考えたいという方は大歓迎です! ぜひ7月11日の第1回研究会(設立総会)を覗きにいらしてください.

 

参考文献
(1)木下 是雄;『理科系の作文技術』,中央公論新社,1981年.
(2)木下 是雄;『レポートの組み立て方』,ちくま学芸文庫,1994年.
(3)阿部 圭一;『明文術』,NTT出版,2006年.
(4)一般財団法人テクニカルコミュニケーター協会 編著;『日本語スタイルガイド』,一般財団法人テクニカルコミュニケーター協会,2009年.

 

しおや・あつこ
イオタクラフト

組み込みキャッチアップ

お知らせ 一覧を見る

電子書籍の最新刊! 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日