実装する前にきちんとドキュメントを読んだ方が良い、という話 - Qiita

どうも、初めまして。 tokeと申します。 今回は自分の失敗談を話したい、と思います。 実装する前にドキュメントを読まないと、最後になってゴールに辿り着けない可能性がある そういう経験をしたのでご紹介します。 例えば、自社で集めた顧客のデータを活用し、Marketoにデータ連携したいとします。 marketoのAPIドキュメントを調べると、顧客の情報を登録する手段では以下の２パターンがあります。 POST /rest/v1/leads.jsonを使うパターン 以下のドキュメントにあるPOST /rest/v1/leads.jsonを使って、顧客のデータを送信し、連携する事ができます。 https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/lead-database/leads [※Marketoで

[peperon_brain]

ジュニアレベルでは見落としがちなところで大事な観点ではあるんだけど、社名出してのTech記事として採用プロモーションにプラスになってるのかな… という疑問はある

[hatest]

リリースする段階で気付くって。。。レビュアも何やってたんだというのとテストで気付けないのは反省しないのか

[t-murachi]

非機能要件の定義の甘さとシステムテスト (性能テスト) の不十分さも要検討だ罠(´・ω・`)

[n314]

普通のあるある記事だと思うんだけど、採用募集広告とセットにしているから騒がれてるのかな。本番のデータ量に耐えられなかったこととかAPIミスって使うとか、たまによくある。

[nicht-sein]

新人がこれをやっちゃうのはあるあるだけど、レビューでスルーされてリリースまでいっちゃうのはどーなのかな？とは思ってしまう

[morimarii]

ヤバイヤバイヤバイ／テストで検出してないのもヤバイし設計・コードレビューで指摘されないのもヤバいしなんなら設計の段階で要件を確認してなさそうなのも超絶にヤバい。ミスとかそういう問題ではない

[getcha]

ここに書かれた情報だけで、要件確認できてないとか、プロセスちゃんとしてないとか批判するのは、見えている / 認識している情報が全てだと思ってしまう。という同じ根っ子の間違いになっていると思う。

[soyokazeZZ]

実装しないとドキュメントを読み解けない民です

[rryu]

同じようなAPIが複数ある場合、事前にドキュメントを読んでも違いがよく分からないことがあるが、一通り動くようになってから改めて読むと分かる場合もある。それで適切じゃない使い方に気づくパターンもある。

[tmdtky]

こんな会社に発注したくないし、関わりたくもない

[Kil]

おいおい、こんな会社に仕事頼んだら絶対だめです、って記事を会社名丸出しにして書いちゃうようなエンジニア雇ってて大丈夫なのか？ 社内コンプラ見直したら？？

[cl-gaku]

チームの先輩は開発中のフォローとかレビューとか全然してくれへんの…？って印象になっちゃうわな

[pwatermark]

ドキュメントを読め、なんていう精神論じゃなくて、「なぜ間違った実装を選んでしまったのか、間違いに気付けなかったのか」を深堀りしないと意味がない コレではこの文章は日記にすらならない

[supersugarrush]

Next.jsもたまにドキュメント間違ってたりするし(propで渡せるオブジェクトとか)ドキュメントが全部正しい訳で3はないけどね。

[ardarim]

ドキュメント読んだほうがいい以前にちゃんと開発プロセス回してる？ドキュメント書いてレビューしてから実装すべきでは？要件定義が甘い気もするし境界テストも負荷テストもやってなさそう

[Yasu2030]

こういうのって、簡単なソフト作ってAPIの動作確認とかしないものなのか？ドキュメントも信用できない場合あるわけだし。

[sds-page]

ドキュメントはちゃんと書いてくれ更新してくれって話やで（ドキュメントでろくに説明されてないので結局ソースコード解読してサンプルソースにも実装されてない機能を推測する羽目になった）

[nemoba]

次の段階として「ドキュメント読んでも嘘が書いてある」を経験して、ちゃんと定義と検証が必要だと学んでくわけすなー(SI屋さんの人がそんな記事書いてると心配になるけど)

[oktnzm]

実装とリリースだけが存在する世界。csvの方がよりいいんだろうが、要件が300件以上とかないのならよくないか？