改善したい時に使う、提案フォーマットの紹介

はじめに

もっと上手く、効率できるやり方を知っている。
でもチームで動いている以上、勝手に自分一人でやり方を変えるわけにもいかない。

いや、でも今の非効率なやり方は耐えられない...！チームのやり方を変えたい！

きっとそんな時に役に立つ、提案する時のフォーマットを紹介します。

提案フォーマット

こちらが提案フォーマットです。

- 題名
- 提案の概要
- 提案理由
- 提案内容

使用例はこちら

お疲れ様です。
現在のPHPでの開発の中で実装におけるルールについて気になったところと、
それに対する提案を考えましたので、お時間がある際に一度ご確認いただきたく思います。

(題名)
実装においての「型」の導入提案

(提案の概要)
開発における、実装手法についての提案です。
可能な範囲で型を指定する実装を行う手法を実践してみるのはどうでしょうか？

(提案目的、理由)
比較の処理において「===」を使うなど
部分的には型を意識したコードになっているのですが、
これだけだとコードの堅牢性という意味でちょっと弱いです。

(提案内容)
そこで以下のルールの追加を提案します。

- 引数の型宣言をする
- 返り値の型宣言をする
- strict_types=1を指定する

それぞれの細かい意味は下記の参考記事を見てもらえればわかりますが、
上記の3項目をルールを実践することで、
ある値の型がどうなっているかがかなり捉えやすくなります。
また型が異なることで起こりうる不具合の発生も抑えることができる見込みもあります。

https://qiita.com/minato-naka/items/cc9da5fc1bc8cc4240a8

ご検討いただければ幸いです。

解説

内容について解説します。

提案の概要

相手に何を提案したいのかを説明するための項目です。
この部分を長文で書くと相手に伝わりにくくなってしまうので、なるべく端的にまとめると良いです。

提案の目的、理由

何を解決、改善するための提案なのかを書く項目です。

提案の目的、理由を相手と共有することで、相手も「何の問題を解決したいのか」を認識することができ、これにより相手と協力して問題の解決を図ることができます。

一番優先すべきことは自分の提案を通すことではなく、問題を解決することです。

解決のための知恵を円滑に借りれるように、必ず目的を伝えましょう。

提案内容

提案の内容です。
具体的なアクション、役割、起きうる効果などについて記載します。

• 誰が
• 何のアクションをする必要があり
• そのアクションによってどういうプラスの効果があるのか

最低限、上記の項目は伝えるようにしてみてください。
どれかに抜けがあると「で、結局それ誰がやるの？」とか「何したらいいの？」みたいな質問がきたり、質問すらされずスルーされたりすることもありますので。

あと、内容はなるべく簡潔な言葉で書くことをオススメします。
基本ちょっとでも相手にとって理解が難しい部分があると、提案というのは通らないものです。
相手に伝わるような言葉選びをするように意識しましょう。

また、参考にしたコンテンツも載せておくのもオススメです。
細かい説明を省くことができますし、説得力も増す効果もあります。

さいごに

無駄に非効率なやり方に従い続けるというのは、割とストレスが溜まります。
他から強制される我慢というのは、得てして楽しいものではありません。

そんな状況に耐え続けるのが辛い、もっと楽がしたい、そんな時にはまずはチームに対して提案をしましょう。

この提案フォーマットがそんな時にお役にたてば幸いです。