それでは、テクニカル・コミュニケーション(以下TC)のお勉強を始めましょう。まあ、肩の力を抜いて…。TCの第一歩は、読む人の身になって考えるところからです。この気持ちがなければ、いくら技術があっても良い文章は書けませんね(^^)。
わかりやすい文書を作るためには、全体の構成やレイアウトの決定が重要です。文書作成技術では、個々の文章や用語の統一などが、よく取り上げられます。もちろん、これらも重要です。しかし、実際の文を書き始める前に、まず文書全体の構成を決めます。
プログラムの設計と同じで、基本設計をしてから詳細設計を行うわけです。
この章では、技術文書の構成に関連する事柄を説明します。
1.1 はじめに
1.2 構成のルール化
1.3 章立て
1.4 段落
−・−
ξ ぶれいく □b コーヒー無礼区 「ドキュメントはちょっと…(^^;。」 一度ならず耳にする話です。ハードの性能が上がり、職人芸的なプログラムの需要は減る一方です。誰が作っても性能が同じ。値段も差がない。とくれば、選択の基準は「使いやすさ、わかりやすさ」に比重が移ります。そこで、大きな要素を占めるのが「ドキュメント」です。 ロジックはスマートで、役に立つプログラムを作っても、ドキュメントが悪いと使ってもらえない。そうなりつつあります。しかも、量を書けばいいってものでもありません。ぶ厚いドキュメントは、思いっきり嫌われます。薄くて、わかりやすく、かつ必要な情報を網羅している。 ・・・うーん、夢のようなドキュメントだ(笑)。 |