続 atsushifxの七転八倒

ウツ、発達障害の闘病記とIT関係のつれずれを書いていきます

マニュアルは設計書の基本

マニュアル道は奥深いらしいので深入りは避けておきます。

ユースケース記述の書き方の本です・・・っていうと反感を買うかもしれないな〓。でも、それが事実。うちの方法論の現在の基盤となっている考え方のひとつです。これに関しては、隠していたといえば隠してますね。システム屋さんには逆に嫌われる(泥臭いし、舶来品じゃないし)だろうな、ってことでIT屋さんとの話で出すのは控えてました。

新人時代に覚えたことですが、
マニュアルでは

  • 1度に1つのことを説明する
  • 操作前の状態を明確に書く
  • 捜査後、どのような状態になるかを明確に書く
  • 元に戻す方法を書いておく

などが必須です。
最初の3つってそのままユースケース記述ですよね。
システムのマニュアルだと、特にそうなんですがマニュアルを書くということはシステムの動作、外部インタフェースを書くことなので設計にも使えます。
というか、まんま設計といっていい。
技術力UPにはマニュアル書きはかなり使えます。

余談ですが、
大学院時代の論文を書くときは「ユーザ・読み手の心をつかむマニュアルの書き方(ISBN:4320008588)」を参考にしました。
技術文書を書くための基本スキルと言えるかもしれませんね。