ドキュメント力

VB6,VBA,VBS,EXCEL,DOS,BAT,WSH,WORDの小技メモ

HTML/ CSS/ CGI-Perl/ JavaScript/ JavaApplet/ AccessUp/ Internet/ EnglishLearn/ ちゃいちゃん天使/ 天使メッセージ/ 飯田ワールド/ 結城ワールド/ プロフィール/ WEB相談室/ WEBアンテナ/ 燈明日記/ Perlノート/ 漢字起源/ yahoo

はじめに

本ページは、ウインドウズ系全般のティプスメモです。

そう、はじめはVB系のティプスメモだったのですが…いつの間にか、ウインドウズ系全般のティプスメモになってしまいました。

ちなみに、ティプス(Tips)とは、マニュアルに書かれていない技法や裏わざのことですが、本ページでは、私が経験してこれはと思ったノウハウのメモになっています。

尚、以下は本サイトの最新情報(ブログ)です。

それでは、本ページが何かのお役に立てれば幸いです。ごゆっくりご覧ください。

◆ドキュメント力

日経SYSTEMS(2006.9)と云う雑誌の『開発ドキュメントの作成力』を読みました。 なかなか良かったのでメモしておきます。

ポイントは5つです!

  1. 最初に構成を考え、論理性を高める
    • 読み手の立場になって伝えるべきことを書き出す。
    • 結論を頂点とした論拠を階層構造として構成する。
    • 構成した階層構造の論理性を検証し要素を補う。
    • そして、結論を先に書き、論拠を順に述べていく。
  2. 意味のあいまいさを排除する
    • あいまいな言葉は、具体的な言葉に置き換える。
    • あいまいな言葉は、具体的な説明を付け加える。
    • 用語は統一する。
    • かぎ括弧やダブルクォーテーションの使い方も統一する。
    • 文の主格を明確にする。
    • 係り受け(修飾)を明確にする。
    • 指示語も具体的に指示にする。
    • 「の」の同格と所有の関係を明確に表現にする。
    • 「が」の逆接と順接の関係を明確に表現にする
    • 強調語は、それ以外にも意味をもつ(同レベルで強調されなかったところへ影響する)。
  3. 文章と図表をバランス良く用いる
    • 文章のみより、図表があると直感的に理解しやすい。
  4. レイアウトの工夫で視認性を高める
    • 見出しを強調する。
    • できる限り見出し要素を抜き出す。
    • 意味的なブロックで余白の切れ目を入れる。
    • 意味的な階層構造でインデントを入れる。
  5. 無駄取りと切れ目で、リズムを整える
    • ひらがなの羅列の無駄取り(出力するためには -> 出力するには)。
    • 漢字の羅列に切れ目を入れる(販売計画立案段階 -> 販売計画を立案する段階)。
    • 読点と句点を効果的に入れる(ビジネスプロセスマネジメント -> ビジネスプロセス・マネジメント)。

おわりに

以下のページには、すべてのTIPSがあります。もしよろしければ、どうぞ!

尚、ご感想、ご意見、誤字、脱字、間違い等がありましたら遠慮なくVB-TIPS掲示板へご指摘ください。