見出し画像

仕様書に「〜という仕様」は書かないでほしい


自己紹介

はじめまして。
都内でWebエンジニアをしております、ケンシロウ(29 男)と申します。

2021年の暮れに他業種からアルバイトとしてエンジニアを始め、
2023年に転職して、正社員としてエンジニアをやっております。
エンジニアとしては、現在2年半ぐらいです。

今は、とある口コミサイトの保守・運用・QA(自称)を担当しています。

なぜ投稿しようと思ったのか

私は完璧思考です。
常日頃思うことは大体、他人にとってはどうでも良いことが多い気がしています。

仕事場では、共感されな(にく)かったことを発信し、共感してもらえる人が1人でも存在したら良いなと思って書いてみます。

前提

まず、私の部門では仕様書は存在しないです。
よく驚かれますし、自分でも驚いています。

PdM風の方が、事業側から受け取った要望をそのまま記載し、
仕様風のドキュメントを書き、それを見てエンジニアが設計します。

そのため、今回は仕様書ではなく、仕様書風のドキュメントには、「〜という仕様」は書かないでほしいと言いたいです。

本題

仕様書風にまとめられたドキュメントには、事業側の要望がほぼそのまま転記されると共に、「お忙しい中大変恐縮ですが」という枕詞が添えられ、仕様書に書いてあるので仕様に違いないが「〜という仕様」と書かれ、「〜していただけないでしょうか」と丁寧な依頼文で記載されます。

例)仕様書風ドキュメント

お忙しい中大変恐縮ですが、機能Bを開発してほしいと要望がありました。

既存では機能Aで運用していますが、〜してほしいとのことです。

〇〇した場合に、△△へ出力するという仕様です。
既存では機能Aはあるので、Cの計算も考慮してほしいです。

5/2までに実装していただけないでしょうか?

何が言いたいかというと、必要な情報がスッと入ってこない。

まだ、箇条書きで適当に羅列してもらうだけで良い。と思ってしまいます。

もちろん、本人・周りのチームにも「端的に記載してほしい」と共有済みで、今後は改善される予定です。

ちなみに私がまとめてほしいと思っている仕様書風ドキュメントはこんな感じです。

例)仕様書風ドキュメント改善案

開発したい機能
機能B

なぜ
部署Xから要望あり
既存の機能Aでは対応できないため

要件
- 〇〇した場合に、△△へ出力する
- 既存では機能A
- Cの計算も考慮

実装希望日
5/2

いちいち冗長な表現を見るたびに気になってしまい、ストレスを感じてしまいましたが、そこが気になっていたのは、どうやらチーム内では私だけのようでした。

こういうの気になる方いませんか•••?


この記事が気に入ったらサポートをしてみませんか?