技術文書も、構造化してください。図1−2のような階層構造が一般的です。
![]() |
原則として、項番は左詰めに揃えます。章、節、項の3段階まで見出しをつけます。見出し(タイトル)によって、内容を簡単に把握できます。見出しを集めたものが、目次になります。従って、目次を見れば、全体の構成と内容が把握できます。
−・−
ξ ぶれいく □b コーヒー無礼区 マニュアルをかいたことがありますか?「どうもうまく書けない」という経験があると思います。いわゆるオペレーションマニュアルは、ソフトができあがってから、書かれることが多いですね。でも、それって本当に正しいことでしょうか? 「ソフトウェアの動作通りに書くべきだから、ソフトウェアが完成しなけりゃ書けないさ。」 確かに、一理あります。しかし、マニュアル上に表現しにくい操作は、わかりにくい操作であることが多いのです。スーッと流れるような操作は、マニュアルでもスーッと記述しやすいものです。 さてさて、これには重要な示唆を含んでいます。つまり、マニュアル作成工程で、ソフトウェアのI/Fを、改善できる可能性があるということです。マニュアルを書くのに苦労するところは、ユーザインタフェースの弱点なのです。 マニュアル作成を事前に行い、仕様にフィードバックする。ソフトウェアの使い勝手をよくする方法のひとつとして、覚えておいて損はないのでは? |