はじめに
エンジニアは、議事録・報告書・設計書といった多様なドキュメント作成しプロジェクトの関係者と合意形成を図りながらプロジェクトを推進します。1
プロジェクト遅延の要因は、合意形成に計画より時間がかかること、正しく合意形成を図れていなかったために手戻りが発生すること、が大きいかと思います。
開発フェーズにおいても、必要な量や品質を担保できないという問題がありますが、こちらは急速にAIが解決している分野で、時間が解決していくと予想されます。2
そうであれば、今後のエンジニアとしては、『作るものをきちんと決めて顧客と手早く合意を取る』仕事の比重が上がるため、議事録・報告書・設計書といったドキュメントを『短い時間で合意形成を得られるような文章で書く』スキルを身につけることが大事と考えられます。
レビュー指摘：『構成が悪い』
レビューで「構成が悪い」といった指摘を受けたとします。
新卒エンジニアのAくんは『なるほど構成が悪いのか、では構成について書いてある本を買って勉強しよう』と考え Amazon でよさそうな本を見つけ、貴重な休日を使って一通りふーんと読みました。
- Amazonで見つけたよさそうな本
エンジニアのための文章術再入門講座 新版 状況別にすぐ効く！文書・文章作成の実践テクニック
ところが、後日のレビューでまったく同じ指摘を受けてしまいました。
貴重な休日を使って勉強したのに最悪な気持ちになってしまいました。
何が悪かったのでしょうか？
※書籍自体は大変良書です。
レビュワーからは提出されたドキュメントしか見えない
文章が出来上がるまでには様々な工程がありますが、レビュワーから見えるのは提出されたドキュメントのみです。
これらの工程は伝言ゲームの様なもので、手前の工程にバグがある場合、次の工程の作業がどれ程正しくても正しいアウトプットにはなりません。
例えば、「いちごが欲しい」と依頼されているのに「りんごが欲しい」と聞き間違えていたら、どんなに入念な市場調査をしても、最終的なアウトプットはりんごを含む何かになるでしょう。フルーツケーキであればいちごを含んでいてセーフと言い張れる可能性もありますが、極めて危うい仕事になりそうです。
レビュワー側で様々「なぜなぜ質問」をして、どの工程にバグがあるのかを遡っていくことはできますが、かなり難易度が高い上に時間がかかります。
一方でレビューイ側で「質の高い問い」を立てることでどの工程にバグがあるのかを探ることもできますが、おそらく「質の高い問い」を立てられるのであれば問題を理解しているので、同じ指摘を２度受ける前にカイゼンしていると考えられます。
そうして考えていくと、構成の悪い文章が書かれるケースで、「構成だけができない」ということはあまりないと考えられます。きちんとカイゼンしていくために大事なのは「どこに問題があるのかを正しく把握すること」です。
問題の把握はスキル的にも気持ち的にも難しいのですが、それを行わないと何度指摘を受けてもカイゼンしない難しい状況になります。
カイゼンに向けて
Claude に「構成力をつけるには？」と問を立てて練習方法を出してもらいました。
自分に何ができて、何ができていないかチェックをするといいかもしれません。
アウトラインを作る練習:
主要なポイントを箇条書きにし、論理的な順序で並べる練習をしてください。パラグラフライティング:
1つのトピックに焦点を当てたパラグラフを書く練習をします。読書と分析:
良質な文章を読み、その構造を分析します。要約練習:
長い文章を短く要約する練習をします。接続詞の使用:
文と文をスムーズにつなぐ接続詞の使い方を練習します。推敲練習:
自分の書いた文章を客観的に見直し、改善する練習をします。テーマ別作文:
様々なテーマで短い文章を書く練習をします。フィードバックの活用:
他の人に文章を読んでもらい、フィードバックをもらいます。
バスケットの選手が「左手は添えるだけ」と習うとその場でシュートができるようになるかというとそういうことはなく、コツを習った上で何度も繰り返しシュート練習を行うことでシュートができるようになるのと同様に、文章も何度も繰り返さないとうまくならないです。
リストの 1-7 が個別でできる練習、8 がレビューに相当するかと思います。
個別でできる反復練習を行わずにレビューだけを行ってもらっていてもカイゼンしないのは容易に想像できるかと思います。
基礎体力をつけよう：写経メソッド
ようやくタイトル回収です。
校庭を走り込んだり、筋トレをしたりしないと、体力や筋力がなくて、そもそもシュートができるようになるまでシュート練習を継続できないです。レベル１でドラゴンを倒しに行ってもポコっと倒されて無駄に時間だけが過ぎて経験値も入りません。
文章の基礎練習は写経です。
写経をすることで字の読み書きの速度を上げたり、正しい文章を覚えたできます。意識せずに素早く動けることで、より難しい課題に取り組むことができるようになります。
ただ、漫然と文章を写しても何も身につかないので以下のようなことを観察しながら写経をすることで、カイゼン練習の 1-6 を行うための基礎力が身につくと思います。
- 正しい文章、読みやすい文章、読みづらい文章
- 何を伝えるのにどのくらいの長さの文章が書かれているか
ブツブツと発音しながら実施すると、口と耳も鍛えられて練習効果が上がるかもしれません。
写経する本は、自分の課題に対して適している本を探して実施して頂くのがよいと思いますが、特に何も思いつかない時のために、ブックオフにて110円で購入した本を紹介しておきます。
- ブックオフで110円の本
わかりやすく説明する力と問題解決力が、1冊でビシッと身につく本
見開き１ページで１トピック構成となっており、文章量も少な目です。ついでに説明力や問題解決力についても学べます。ただ読んでもふーんと通り過ぎてしまう内容が、写経をすることによって理解度も高まると期待できます。3
一方で、今更こんな地道なことを…と気分が乗らない方は、以下の書籍を読んでみるのもいいかもしれません。
- 効率的な学び方が学べる本
エンジニアの知的生産術 ──効率的に学び、整理し、アウトプットする
いずれにしても何度も同じ指摘を受ける時は今の自分の中に解決方法がない可能性が高いので、なんらかのインプットや反復演習が必要かとは思います。
おわりに
わたし達が日常生活を送る上では、長文の読み書きを行う場面はほとんどないです。
ですので、エンジニアとしてドキュメントを作成してコミュニケーションを取れるようになるには地道な訓練が必要です。
もしも、高稼働で仕上げたドキュメントをレビューで一蹴されるような仕事をされているのであれば、地道な訓練で基礎体力をあげることも検討されるとよいかと思いました。
おまけ
-
kaku3 - Qiita記事一覧
ポエム多め。PM、メンター、未経験エンジニアや新卒向け記事など。 -
エンジニアのためのお仕事問題集
2030年にIT人材が最大79万人不足するとのことで、学習用の資料をgitで無料公開してます(不定期更新)。
よろしければどうぞ。