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

塩谷 敦子

この連載では,ライティング・スキルの話だけでなく,仕事をうまく進めるための「文書の作り方」として,「文書作成術」を解説してきた.文書の書き方が仕事のやり方に大いに関係していることに気づいていただけただろうか.「そうは言っても,いざ現実の自分の仕事に戻ると,とても文書なんか作っていられない」という方も,まだまだ多いかもしれない.そんな方々の仕事の助けとなることを信じて,ヒントやメッセージを出し続けていきたいと思っている.今回は,最終回として,これまでの内容を総括する.(筆者)

 

技術解説・連載「理系のための文書作成術」 記事一覧
第1回 開発文書を分かりやすく記述する
第2回 図表を表現手段として活用する
第3回 開発文書の書き方はしごとのやり方を示す
第4回 自分の「赤ペン先生」を持とう
第5回 設計レビューでするべきこと,してはいけないこと
第6回 仕事で文書を「書かされている」あなたへのメッセージ

 

●お知らせ
 連載「理系のための文書作成術」が電子書籍になりました!
 ご購入は「Tech Village 書庫&販売」のページから.

 

●なぜ文書を作るのか?

 皆さんが仕事で文書を書くのは,なぜですか? 例えば,開発を仕事にしている方は,なぜ開発文書を書くのでしょうか?

  • 上司や先輩や品質保証部に「書け」と言われるから.
  • 会社で決められた標準プロセスの各工程レビューのために,各工程成果物である文書が必要だから.
  • ISO9000などのために,文書が必要だから.
  • 納入先から文書を求められているから.

 このようなきっかけで作成した文書は,その内容ではなく形式や存在だけに重きが置かれることになります.そして,文書を作成する作業に,「やらされている」,「書かされている」という感覚が出てきます.このように,単に文書を存在させるために書くことを強いられると,ドキュメンテーションに対して,拒否感や面倒さを感じるようになってしまいます.

 このように,文書作りのきっかけから来るドキュメンテーションへの抵抗感のほかに,「文章を書くのは苦手だ」,「理系には文章を書くことが求められてこなかった」などという,理系の人の多くが示すドキュメンテーションへの抵抗感もあります.実は,筆者も理系です.ある時期までは,このような言い訳をして,ドキュメンテーションに抵抗感を持っていました.

 しかし,開発文書の多くは技術文書です.その内容は,目的に向かって論理的に事柄を構成し,展開しながら作り上げていくものです.まさに理系の人の得意とするべき作業のはずです.ですから,「文書を書くのが苦手だ」というのは理系の人の言うことではないはずなのです.おそらく,理系の人が持つ抵抗感は,「書かされている」という抵抗感なのではないでしょうか.

●ソース・コードも「開発文書」

 また,ソフトウェア開発者の中には,「文書書きは苦手だが,プログラミングは好きだ」という人が多くいます.筆者は,プログラムもまさに書き手の考えを論理的に構成し展開して作り上げる技術文書ととらえています.そして,プログラムはコンピュータがどのように動けばよいのかを記述した仕様書です.

 ソフトウェア開発を一つの大きな工程と見ると,次にある工程はコンピュータの動作工程といえます.ですから,プログラミングとは,次工程(コンピュータの動作工程)でコンピュータが行う作業について正確に記述し,次工程担当者(コンピュータ)が持つ能力を十分に発揮させるための仕様書を作ることです.文書作りはいやだと言いつつもプログラミングに心を込めて良いプログラムを作る開発者は,実際には優れた文書作成者なのです.そして,プログラミングという作業は文書作りそのものなのです.

 プログラミングという作業と,プログラムという文書作りは分けて行えるものではありません.それと同じで,設計作業と設計書作りは分けて行えるものではなく,設計作業そのものが設計書作りなのです.そして,良いプログラムを作る開発者こそ,次工程の設計作業や製作作業を正確かつ効果的に実施できるための仕様書作りも得意なはずです.

 この連載の第3回「開発文書の書き方は仕事のやり方を示す」では,開発作業とドキュメンテーションを連動させよう,という話をしました.そして,そのコツをいくつか紹介しました.今回は,このように「開発作業とドキュメンテーションを連動させる」と,どのような嬉しいことがあるのかをお話しして,皆さんが持つ「書かされ感」を少しでも減らすことができればと思います.そして,特に,プログラミングが得意な開発者の皆さんは,実は優れた文書作成者である素質を持っていることに気づいていただければと思います.

組み込みキャッチアップ

お知らせ 一覧を見る

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