はじめに
こんにちは！
クリスマスも差し迫っておりますが、皆さんどうお過ごしでしょうか？
CYBIRD Advent Calendar 2025の23日目担当、@ny512です。
22日目は@cy-n_aoさんの「今日の献立をGASに決めてもらうスプレッドシートを作ってみた」でした。
自己紹介
私はサイバードの品質管理部に所属しており、QA業務はもちろんのこと、メンバー育成にも力を入れて取り組んでおります。
概要
皆さんはこのように言われたことはありませんか？
「文章がわかりにくい」「回りくどい」「もっと簡潔に書いて」「結局何を伝えたいの？」など…。
品質管理もといQAにおいて、読みやすく伝わりやすい文章を書くスキルはとても重要だと考えています。
というのも、QAは「文章を書いて相手に伝える」ことを常に行っている職種だからです。
今回は私が心がけている「相手が読みやすく伝わりやすい文章」について、紹介していきます
例文1
以下、とある障害が発生した際に報告として提出された文章の例です。
ある操作フローにおいて、アイテムセットを購入して続けて機能を実行しようとすると、エラーが発生しトップ画面に戻されるという現象について、以前にも数件問い合わせがありましたが、社内で再現できず、報告件数も少なかったため、当時は経過観察としていました。
しかし今回、同様の問い合わせが再び発生し、重要度を上げて調査を行ったところ、特定のバージョンから導入された仕様変更が原因であることが判明しました。
具体的には、購入処理が終わった後に画面を閉じる際、並行して複数の処理（例えば、状態の更新と別画面の確認）が同時に動作し、処理の順序によっては一方がキャンセルされ、結果として必要なデータが反映されないまま次の機能が実行されてしまう、という問題でした。
現在は修正用のプルリクエストが既に用意されており、次回のアップデートで対応が反映。
言いたいことはわからないでもないですが、何度か読み直さないと脳内に内容が入ってこないように思います。
色々と工夫すれば、もっと読みやすく、且つわかりやすい文章にまとめられそうです。
何が原因で「わかりづらい」「読みづらい」のか？
簡潔な文章、という観点でこの文章を見ると、以下の点が挙げられます。
- 一文が長く、読み手に負担がかかる（接続詞が多くて構造が複雑）
- 情報の優先順位が曖昧である（何を一番伝えたいのかがぼやけている）
- 時系列、因果関係がわかりづらくなっている（「その時何が起きたのか」が後回し）
- 丁寧語と体言止めが混在していて、読みづらい
これらを一つずつ解消していけば、良い文章になりそうですね。
さっそく直してみた：その１(文章型）
特定の操作において、アイテムセットを購入すると、エラーが発生しトップ画面へ戻ってしまう不具合が発生しました。
以前も同様の問い合わせはありましたが、社内では再現できず問い合わせ件数も少なかったため、対応を保留としておりました。
今回、改めて同様の問い合わせがあったので、詳細に調査を実施したところ、購入処理終了後、画面を閉じた際に複数の処理が並行して走り、処理の順序によっては一方がキャンセルとなり、必要なデータが反映されないまま次の機能が実行されてしまうといったことが原因と分かりました。
現在は修正を行い、次回のアップデートにて対応が反映される予定です。
いかがでしょうか。
一番伝えたいポイント（事象・経緯・原因・対応）は抑えつつ、読みやすくなったのではないでしょうか。
元の文章にある「特定のバージョンから導入された仕様変更が原因」は、要因にあたるので今回は一旦省略としました。
補足として最後に一文付け足しても良いかもしれませんね。
さっそく直してみた：その2(箇条書き）
特定の操作において、アイテムセットを購入すると、エラーが発生しトップ画面へ戻ってしまう不具合が発生しました。
現在は修正済で、次回アップデートで反映予定となっております。
また、本事象における経緯、原因は以下となっております。
- 以前から同様の問い合わせが発生していたが、社内で再現できず件数も少なかったため、保留としていた
- 今回、同様の問い合わせがあり、調査を開始した
- 調査の結果、以下が判明した
- 購入処理終了後、画面を閉じた際に複数の処理が並行して走った際に、処理の順序によっては必要なデータが反映されない（複数の処理の片方がキャンセルとなってしまう）
- 結果として、次の機能実行時に不整合が発生してしまった
- 更に、本事象については、過去に対応したアップデート内容が原因で発生していた
今度は結論→経緯・原因の順にまとめてみました。
PREP法という手法にもあるように、結論から書いて要点をあとで書く型はビジネスシーンでも好まれる書き方です。
文章にまとめるのが苦手だ…という人ほど、この書き方を意識してみると良いかもしれません。
（私はこの部類なので、意識的に箇条書きの型を使っています！）
例文2
今度は不具合報告での例文になります。
特典一覧のランキングの内容において、仕様書では1～10位の特典がカード・ガチャチケット・ダイヤとなっているが、実機ではカード・ストーリーチケット・ダイヤとなっている
悪くはない…！と思いますが、もっと複雑な事象の報告をするとなった際にこの書き方では応用を利かせられない懸念があります。
無理に一文にまとめずとも、わかりやすい内容に出来そうです。
さっそく直してみた：箇条書き
特典一覧画面にて、以下ランキング特典（1～10位）の内容が仕様書と実機で相違している
- 仕様書：カード・ガチャチケット・ダイヤ
- 実機：カード・ストーリーチケット・ダイヤ
箇条書きにすることで、ぱっと内容が脳内に入ってくる気がします。
また、この書き方だと内容がもっと複雑になった際もすっきりとまとめられそうです。
まとめ
いかがでしたか？
要点を押さえれば、誰でも簡潔に、読みやすく、相手に伝わりやすい文章は書けます！
テレワークが普及し、チャットツールでのテキストコミュニケーションが主流の今だからこそ、色んな職種の方に当てはまる課題だと思います。
色んな方に参考にしてもらえたら嬉しいです
最後に
初めてのアドベントカレンダーでしたが、最後まで見てくださりありがとうございました！
明日のCYBIRD Advent Calendar 202524日目は、@cy-yamakenさんの「Proxyで理解する、JSデータバインディングの仕組み」です。
ぜひご覧ください