優れた開発者体験(DX)を作るものは何か?
(leerob.io)フレームワークとライブラリ
- できるだけ素早くオンボーディングできること
- アップグレードが容易であること
- 役に立つエラーメッセージ
- 強力なデフォルト値とコンベンション
- デフォルト設定から抜け出せるようにすること
- 依存関係によってリスクを減らすこと
ドキュメント
- コードで説明する(例を提供する)
- 問題を解決する(質問に答える)
- ドキュメントを自動生成する(APIドキュメントなどを最新に保つ)
- エラーの解決方法も整理する
- Skimming(ざっと読むこと)に最適化する
- 正確であること(専門用語や慣用句を避ける)
- 複雑なものは段階的に見せる
APIs
- APIワークフローを壊さないこと(Versioning):Stripe のように
- APIを素早くテストできるようにすること:Square はこれが得意
1件のコメント
「Skimming(ざっと読むこと)に最適化する」という点は、とても共感できますね。