新人PGとの書簡 マニュアルのチェックの仕方

お疲れ様です。Tです。

 

午前中から午後にかけてマニュアル作成の手伝いをしました。

具体的には画面のキャプチャーになります。

システムを知らない人からみて、わかりづらいところがあったら、教えてほしいといわれたのですが、指摘できませんでした。

 

 

Tさん

 

「システムを知らない人からみて、わかりづらいところがあったら、教えてほしい」

これはけっこう大事なポイントですね。何度か見返して、ぜひ指摘箇所を見つけましょう。

以下、見直す時に観点として気をつけてください。

 

用語

一般の人が見慣れない用語がないか

そういった用語に説明があるか

 

明確さ

例えば、正しいユースケースでは「ユーザーが○○に××する。システムは△△を表示する。」といった書き方をします。

そのままUMLに機械的にモデリングとして図形化できるか、が目安です。

マニュアルではユースケースより柔らかく表現すると思いますが、文章を見て何をするか明確化を測るために「ユースケースだったらどう書くか」を念頭に置いて見ると良いかと思います。

 

構成

目次だけ、章立てだけ見て、内容がイメージしやすいかどうか

 

どうでしょうか?こういった観点で見直してみてください。

Posted in

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

*

次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> <pre class="">