森崎修司の「どうやってはかるの?」:ITmediaオルタナティブ・ブログ (RSS) 森崎修司の「どうやってはかるの?」

計測できそうでできない多くのこと。エンピリカル(実証的)アプローチで。

他人の書いたソースコードをみて学べという話はよく聞くが、他人の書いた設計書等をみながら日本語の書き方を学べ、という話はそれほど多くは聞かない。ただ、曖昧な表現をするなという話を聞いたことがない方はいらっしゃらないだろう。

ソフトウェア開発に限定されないが、技術文書を書くことはテクニカルライティングと呼ばれている。テクニカルライティングでは、事実を読者にわかりやすく伝えることに主眼がおかれている。事実を淡々と書くというと一見簡単そうだが、実際には曖昧さ、モレがないドキュメントを書くのは難しい。意図せず、読者を誤解させるような文章を書いた経験は誰にでもあるだろう。

このエントリではテクニカルライティングに参考になる読み物があるので紹介する。昨年の6月からgihyo.jpではじまった松下 健次郎氏の「Webゆえに考える テキスト編集のテクニカルコンセプト」の連載だ。いくつかは、Webサイトの文書作成に特化した形で書いてあるが、以下の回は一般的なテクニカルライティング(ソフトウェア開発で作成するドキュメント)にも活用できる。

「可読性を高める」に書かれていることは、比較的短時間で実行に移せることが多い。どのあたりが、ご自身のソフトウェア開発のドキュメント品質の向上に活かせるだろうか。

森崎

Special

- PR -
コメント

コメントを投稿する
メールアドレス(必須):
URL:
コメント:
トラックバック

http://app.blogs.itmedia.co.jp/t/trackback/77444/18292262

トラックバック・ポリシー


» このブログのTOP

» オルタナティブ・ブログTOP



プロフィール

森崎修司

森崎修司

ソフトウェア開発に携わる方に気づきを提供することを目指し、ソフトウェア開発の定量化/効率化/高品質化の動向を国内・海外、実務・研究から多面的に紹介し、研究者の視点、自身の業務経験をふまえた視点から考察します。現在、静岡大学 助教

詳しいプロフィール

カレンダー
2012年2月
      1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29      
カテゴリー
エンタープライズ・ピックアップ

news094.gif 富士通元社長の山本卓眞氏が残した次代へのメッセージ
富士通の社長、会長を務めた山本卓眞氏が亡くなった。哀悼の意を込めて、日本のIT産業界の大御所が残した次代へのメッセージを紹介しておきたい。(2/6)

news094.gif Facebook就活はもう古い?
約260人のブロガーが、ITにまつわる時事情報などを日々発信しているビジネス・ブログメディア「ITmedia オルタナティブ・ブログ」。その中から今回は「就活」「都心の雪」「ソーシャルメディア」などを紹介しよう。(2/4)

news094.gif 東北をコットンの生産地としてブランディングしたい──リー・ジャパン・細川取締役
塩害に強い綿の生産で東北に新たな産業を作りたい。オーガニックコットンの採用など、環境負荷を下げるジーンズ生産に取り組んできたリー・ジャパンの新たなチャレンジとは──。(1/30)

news094.gif 東北から始まるイノベーション
企業のICTを活用と若手IT技術者による東北発のイノベーションが、中長期的な震災復興の鍵となる。(1/27)

news094.gif 貧困国の雇用を創出する印刷屋、丸吉日新堂印刷の挑戦
全国から約2万7000件の名刺制作を受注をする札幌の小さな印刷会社の成功の秘密は、地道な社会貢献にあった。(1/16)

オルタナティブ・ブログは、専門スタッフにより、企画・構成されています。入力頂いた内容は、アイティメディアの他、オルタナティブ・ブログ、及び本記事執筆会社に提供されます。

Special

- PR -

サイトマップ | 利用規約 | プライバシーポリシー | 広告案内 | お問い合わせ