どしろうと製作所:WebLog

どしろうと製作所のBlogバージョンです。
「どしろうと製作所」のHPの記載内容とはあまり関係無いです。
気が向いたときのみ更新します。
読みやすいモデルの重要性とコツ◆Д皀妊襪任澆蕕譴觀晃の紹介
前回に続き「ETロボコン Advent Calendar 2016」向けに書いてみております。

今回は、前回紹介したチェックリストに対応する「モデルでみられる傾向」について具体的に紹介しておきます。
ちょっとした気づかいが抜けちゃうことで残念になっちゃいますので、「あるある」的に目を通して貰えると良いかもです。

■ETロボコンのモデルでみられる傾向(サマリ)

前回紹介した(チェックリストに対応する)傾向はこちらです。
・分かりづらい表現
・曖昧な記述
・記述の揺らぎ
・適切な名前
・ポイントずれ
・構造の整理

それぞれを順に紹介しておきます。


■傾向:分かりづらい表現

こちらは、学生さんに多いかもしれません。分かりやすい例としてはタイトルと簡単な説明と共に以下のようなグラフだけが書かれる場合があります。
ざっくり表記

何となく分からなくもないですが、いろいろ情報が不足しておりますね。
単位、数値、グラフの色の意味といったグラフに必要な情報だけでなく、補正の結果どうなったかどうか?という記載もない場合があります。
たぶん右側のグラフは、2つの線が重なっているために1色の線しか見えないようになったということかもしれません。

あくまでグラフは結果としての情報を示すものですので、目的に対してグラフで達成出来たことを分かるように補足や説明を行った方がよいでしょう。以下の改善だけではモデル評価の上位になるとは言い難いですが、理解しやすさは改善されております。
訂正例…つかれた

なお、こちらはグラフを例としましたが、図表全体に関して発生しやすい内容となりますので、注意しましょう。


■傾向:曖昧な記述

ETロボコンでは提出枚数が限られてますので、スペース省略を目的で表現も省略する場合もあるかもしれないのですが、少しだけ分かりやすい表現を行うように意識した方が良い場合があります。
例えば、アクティビティ図の分岐で分岐条件を記載せずに「YES/NO」だけ記載されている場合があります。
こちらもなんとなく分からなくもないですが、少し意識するだけで分かりやすくなります。
補足と表記の変更


また、モデル作成段階では「検討中」であろうことが予想されるのですが、ぼかした表現を使っている場合も見られます。
「さまざまな(あらゆる)パターンに対応する」といった表現ですね。
モデル審査側としては「この部分、検討不足かな…?」とも読みとってしまいますので、最終的なモデル上の表現としては減らした方がよいでしょう。

他にも、「勢いよくスタートする」といったものも具体的なイメージが得られません…

これらは、他の人に読んで貰うことで「分かりづらい」と指摘される思いますので、出来れば分かりやすい表現に直すと良いでしょう。


■傾向:記述の揺らぎ

記述の揺らぎは非常に多いです。モデルをページ単位で担当者を分けるような場合などには発生しやすいかもしれません。
用語の揺らぎは多いですー

例えば、「区間距離ぁ廚箸いν儻譴制御戦略上に記載されて、「ゲート判定開始距離」という用語がクラス図に記載されているとします。双方、スタートからの距離を判定して処理する同一パラメータのようですが別用語になっております。

別用語になっていることで、(上記ではまだマシですが)分かりづらくなるだけでなくクラス図と要求とのトレーサビリティが「?」となってしまう場合も有ります。
同一の概念であれば、出来る限り一貫性のある記述を行いましょう。


■傾向:適切な名前

ETロボコンでは新しい制御方法や概念に対しては何らかの名前をつけると思うのですが、適切な名前を使うようにした方が分かりやすいですし、他のチームからも真似されやすい、伝搬力のある内容となります。

例えば、既にある要素技術ですが「自己位置推定」を「場所判断」という表現にしてしまった場合を考えてみましょう。「場所判断」という名前に変わるだけで、エンコーダのみで判定する制御では無く、超音波センサも使った制御方法のようにも見えてしまいます。

適切な名前を使うことは理解の早さにもつながり、結果として読みやすさの向上につながります。
複数のチームメンバーの知見を統一するだけでなく、より多くの人に使える技術を目指す場合には特に名前の付け方は重要となりますよ。


■傾向:ポイントずれ

最初の「分かりづらい表現」とも一部重複するかもしれませんが、「自己位置推定」と記載しているのにジャイロや超音波センサのグラフを張り付けているような場合です。
あれ?あわない

上の例は極端で存在しないかもしれませんが、タイトルから想像される内容と異なる情報が記載されていることは多く見られます。
特に新しい制御方法などを提案するときには、「適切な名前」と共に気を付けた方が良い部分です。


■傾向:構造の整理

極端に大きなクラス図上のパッケージや巻物のように長いアクティビティ図は非常に見づらいです。
巻物でござる

また、大きなものを分割する際も大きさをある程度そろえるようにしましょう。
上記の巻物アクティビティ図を分割したとして、以下のようにすると…
謎の分割

日本地図を以下のように分類したような違和感が発生します。

---------------
札幌
本州
 |−青森
 |−秋田
 |−宮城
 |−関東地方
 | |−XXX
関西圏
 |−滋賀
 |−大阪・京都近郊
 ・・・
---------------

適切な切り口やサイズでの分割はモデリング能力の向上に繋がり、クラス図の整理能力も高くなります。この「構造」については、クラス図やアクティビティ図だけでは無く、図全体や文書構造に対しても気を付けてみましょう。


以上の内容がチェックリスト形式で改善対象となる問題の傾向となります。
簡単に修正できる部分も多いですので、モデル提出前にでも簡単に目を通して貰えると良いかもしれません。

以上、参考となりましたら幸いですー。

| ロボット | 10:57 | comments(0) | - |









 123456
78910111213
14151617181920
21222324252627
28293031   
<< May 2017 >>
+ SELECTED ENTRIES
+ RECENT COMMENTS
+ CATEGORIES
+ ARCHIVES
+ LINKS
+ PROFILE
+ OTHERS
このページの先頭へ