こんにちは、そして初めまして、QAコンサルタントのsakkyです。
私達は日々、短いものから長いものまで、色々な文章を書いていますが、文章を書くのを苦手に感じたり、なんだかイマイチしゃっきりしないと感じたり、記載の過不足があるのではないかと思ったりする事も多いのではないでしょうか？
私自身、要求仕様書から実装仕様に落とし込みをする時に、お客さんとの会話で認識していた事を書き忘れていてメンバーから「このパターンもあると思うけど、記載がない。どう動くべき？」と言われてハッとした事もあります。メンバーが気付いてくれなければ仕様漏れしたアプリをリリースしてしまう所でした。
また、「ちょっといい書き方が出来なかった気がするけど、理解は出来るよね？」と思って書いた部分について、「この書き方だと、処理中でも処理後でもいいように取れるんだけど、処理終了前に完了していないとダメなんじゃない？実際はどっち？」と、記載の曖昧さによる事実確認をされたりすることもありました。
最初から抜け・漏れや曖昧な記述を排除出来ていれば、発生しなかったやりとりで、相手に確認の時間を取らせる必要もなかったはずです。また、近くに居れば会話で済ませられますが、お客様とのやり取りやリモートワークでの遠隔でのやりとりとなると、確認の文章を考えたり、言われた事の意味を念の為に再確認したりと、やりとりが増えたりして余計に時間がかかってしまう結果となる場合が多々あります。(待ってる時間も勿体ないですよね)
そこで、私が普段文章を書く時に、上記のような認識齟齬や問い合わせが発生しないようにする為に気を付けている事を洗い出し、その中からひとつピックアップしてどんな事をしているかをお見せしたいと思います。
文章を書く上で気を付けている事を洗い出す
まず、自分が普段文章を書く上で気を付けている事(簡潔に、抜け・漏れなく、読みやすく、わかりやすく、認識齟齬をなくす)を、思いつくままにピックアップしてみます。
- 文体は統一できてる?
- 粒度は均一?
- 句読点多すぎない?
- 用語は統一できてる?
- この用語は通じる?
- 5W1Hにあてはめる
- 以上・以下・未完・超過を分けて使えてる?
- 曖昧な表現ない?
- もっと短く出来るはず!
- 分割した方が良くない?
- 纏めた方が良くない?
- 前後入れ替えたらどう?
- 箇条書きにする
- 表にする
- 図にする
- 対で考える
- 絶対に誤字・脱字はある!
- 見直し3回!
- 一晩寝かせる
- 印刷してみる
- 誰かに(部分的にでもいいので)チェックしてもらう
- 目次だけでも作ってみる
- 言いたい事を箇条書きにしてみる
どうでしょう?
思ったより多いような、少ないような?
常に意識しているもの、気になった時や詰まった時だけ使っているものがありますが、今回は「5W1Hにあてはめる」に焦点を当ててみたいと思います。
5W1Hにあてはめる
なぜ「5W1Hにあてはめる」を選んだかと言うと、文章を書く上で抜け・漏れのチェックに大いに役立つからです。
何度も色んな所で見聞きしている5W1Hは、When(いつ)、Where(どこで)、Who(だれが)、What(なにを)、Why(なぜ)、How(どのように)の、5つのWと1つのHの事です。
5W1Hを使うメリットで良く言われる事に「現在の状況を客観的に見る事ができ、頭の中が整理される。頭の中が整理される事により、改善や立て直しをやりやすくなる」、「5W1Hを使って情報を伝えると、相手との認識ずれを防ぐことが出来る」と言ったものがあり、まさに私が文章を書く時に気を付けている事にぴったりと当てはまる内容です。
書いた文章を5W1Hに当てはめて該当するものに対する記載の有無を確認する事により、記載する情報が必要十分であるか、抜け・漏れがあるかをチェックする事が出来ます。(客観視、認識ずれ防止) また、5W1Hにあてはめる為に文章を再確認し、過不足があればどのように文章を書き直すかを考える事になる為、より読みやすい文章へ書き換えるチャンスも増える事となります。(改善) さらに過不足がなくても5W1Hにあてはめた部分を眺めていると、並べ替えて読みやすく出来そうな事に気付く場合もあり、文章改善のチャンスが増えます。(重点的に見直ししているとも言えますね)
では、実際にやってみましょう。
まずは、以下のような表を作ります。
手書きでも、Excel表を使っても、頭の中で思い浮かべるだけでも良いですが、慣れない内は書き出せるものがあった方がやりやすいと思います。(チェック項目は英語・日本語併記で作りましたが、いずれかだけでOKです)
| 項目 | 該当箇所 |
|---|---|
| When(いつ) | |
| Where(どこで) | |
| Who(だれが) | |
| What(なにを) | |
| Why(なぜ) | |
| How(どのように) |
次に、自分が書いた文章をそれぞれに当てはめてみます。
例として以下の文章を使ってみましょう。
データ投入者が商品情報を全て入力し終えたら[実行]ボタンを押します。全てのデータが正常に入力されていれば確認画面が表示されます。エラーがあればエラーメッセージが表示されます。」
最初に、文章を分割してみます。
まず大きく2つに分けられそうです。
入力する部分である「データ投入者が商品情報を全て入力し終えたら[実行]ボタンを押します。」と、チェック結果である「全てのデータが正常に入力されていれば確認画面が表示されます。エラーがあればエラーメッセージが表示されます。」です。
次に、前者について更に分割してみましょう。
データ投入者が｜商品情報を｜全て入力し終えたら｜[実行]ボタンを押します。｜
分割が終わったので、それぞれを表にあてはめてみましょう。
「データ投入者が」は、 “だれが” にあてはめられそうなので、Whoに入れます。
| 項目 | 該当箇所 |
|---|---|
| When(いつ) | |
| Where(どこで) | |
| Who(だれが) | データ投入者 |
| What(なにを) | |
| Why(なぜ) | |
| How(どのように) |
「商品情報を」は、 “なにを” にあてはめられそうなので、Whatに入れます。
| 項目 | 該当箇所 |
|---|---|
| When(いつ) | |
| Where(どこで) | |
| Who(だれが) | データ投入者 |
| What(なにを) | 商品情報 |
| Why(なぜ) | |
| How(どのように) |
「全て入力し終えたら」は、 ”いつ” にあてはめられそうなので、Whenに入れます。
| 項目 | 該当箇所 |
|---|---|
| When(いつ) | 全て入力し終えた |
| Where(どこで) | |
| Who(だれが) | データ投入者 |
| What(なにを) | 商品情報 |
| Why(なぜ) | |
| How(どのように) |
「[実行]ボタンを押します。」は、うーん、どこがいいでしょう？
なんとなく “どのように” にあてはめられそうな気がしなくもないので、仮であてはめてみます。
| 項目 | 該当箇所 |
|---|---|
| When(いつ) | 全て入力し終えた |
| Where(どこで) | |
| Who(だれが) | データ投入者 |
| What(なにを) | 商品情報 |
| Why(なぜ) | |
| How(どのように) | [実行]ボタンを押します |
あてはめた結果を考察する
あてはめて見ると「Where(どこで)」と「Why(なぜ)」が埋まりませんでした。
ここで、あてはめられなかった部分に対する文章が必要であるか否かを考えてみます。
Whereは、暗黙の了解もしくは前段の文章で「現在表示中の画面」と言う言葉が隠れていそうです。
一連の流れで操作する画面にたどり着いていると思われるので、前の文章が想定通りに画面にたどり着けるようになっていれば明示しなくても良いと判断できます。
Whyは、最初の文章分割で大きく2分割した2ブロック目の実行ボタンを押した結果を見ると、データ投入者が投入したデータの正当性をチェックする為であると読めそうです。
文章が仕様書であれば正当性チェックを何故行うか、どのように行うかの文章が必要になりそうな気がします。ユーザーマニュアルであれば、文面から(エラーチェックが行われる事、)正常なら確認画面に遷移する事、エラーならエラーメッセージが出る事が記載されていて、暗黙のエラーチェックの実行と、結果による分岐がある事が分かる為、ケースバイケースで文章の追加を検討する必要がありそうです。
また、「[実行]ボタンを押します」のあてはめにちょっと困ってしまいました。
あてはめに困る部分がある場合は、文章分割が細かすぎたり大きすぎたりする事が理由になっている事もあるので、あてはめを中断して文章分割を見直してみるとうまくあてはめられる場合があります。あてはめられる場所を深く考えすぎずに一旦考え直すのも良いと思います。
こういった割り当てられなかったり、文章分割し直しした部分については、何回も5W1Hあてはめをやっていると何となくやれるようになって来たりもするので、うまく行かなくても多少強引にやってみるのが良いかなと思います。強引に行ったり、組み替える事により新たな気付きが発生するかも知れませんから。
考察をもとに文章の改善を考える
考察では、Whyの部分に当たる文章の要否検討をした方がいいと結論が出ました。
ここからが難しい所ではあるのですが、チェック対象文章をもう一度見てみます。
「データ投入者が商品情報を全て入力し終えたら[実行]ボタンを押します。全てのデータが正常に入力されていれば確認画面が表示されます。エラーがあればエラーメッセージが表示されます。」
試しに「データ投入者が商品情報を全て入力し終えたら[実行]ボタンを押します。」と「全てのデータが正常に入力されていれば確認画面が表示されます。エラーがあればエラーメッセージが表示されます。」の間に文章を入れてみましょう。
「[実行]ボタンを押した後、入力データのエラーチェックが行われます。その結果、」なんてどうでしょうか？
「データ投入者が商品情報を全て入力し終えたら[実行]ボタンを押します。[実行]ボタンを押した後、入力データのエラーチェックが行われます。その結果、全てのデータが正常に入力されていれば確認画面が表示されます。エラーがあればエラーメッセージが表示されます。
[実行]ボタンを押した後の挙動が明示されました。
再度、文章を読み直し、追加した部分があった方が良いのか、冗長なのか、別な表現の方が良いかと言った事を考えてみます。
それを繰り返し、よりよいと思う文章にしていきます。
おわりに
文章を分割して5W1Hにあてはめてみると、記載が必要なものの抜け・漏れが検出できる事が確認出来ました。
何かしっくりこない場所、記載が足りないと感じる場所で効果を発揮すると思いますので、やった事がない方は試してみると良いと思います。
また、慣れて来ると表を用意しなくても頭の中であてはめが出来るようになり、文章の記述スピードも上がって来ると思いますので、最初は苦労しても何回かやってみると良いと思います。
5W1Hは検索してみると色んな記事がすぐに見つかる位に有名で、色んな所に応用が効きます。
文章を考える時、チェックする時など、何回も活用していけば自然とその思考が身に付き、他に応用が効くようになると思いますので、継続的に実践してみることをおすすめします。
私の経験則ですが、文章は意識して書けば書く程、書き方が良くなっていきます。量が質になるパターンですね。
日報とかちょっとしたメッセージでも意識して書いてみると書く練習になりますので、気が向いた時にちょっとだけ意識を向けて文章を書いてみてください。
ふとした時に、文章を書く苦手意識が減っていたり、意識しなくても文章が良くなってるなと思う事があるようになると思います。
最後に、一言。
私は、この手のテクニックの紹介は、気になるものをちょっとつまみ食いしてみて、自分に合えば使えばいいし、合わなければ捨てればいいと思っています。
先にピックアップしたもので「お、これは使えそう」と思われるものがあれば、是非試してみてください。きっとどこかでプラスになります。
(「いやいや説明してもらわないと使えないよ」と言うものがあれば、また次回と言う事で…)
