Skip to content

改善提案: README・導線・API・信頼感の強化と導入体験の向上 #17

@Syati

Description

@Syati

概要

このgemの価値をより高めるための改善点と、その背景を辛口視点でまとめます。現状の利点を活かしつつ、さらに「誰が・なぜ・いつ使いたいか」が伝わるプロダクトへ近づけるための案です。


1. README 冒頭の訴求点を尖らせる

  • 何のためのgemか(主役は何か)を1文で端的に伝える
  • APIパラメータの型安全+ネスト対応など、書いて“得する”状況をクリアに示す

2. 強みの明確化 (validates_raw/ネスト/Rails統合)

  • validates_raw やネストエラー周りをもっと目立たせる
  • 「なぜStrong Parametersだけでは困るのか」「dry-schema等との差分は何か」も短く触れる

3. 導入体験(register_types等)の自動化・簡略化

  • 初期化をRailtie等で自動化し、README設置手順を一つ減らす
  • もし手動維持なら、未設定時のエラーメッセージを親切に

4. APIの一貫性(new/permit等)

  • Params.new(params)Class.permit(params)か迷わない設計(入口統一など)
  • API利用例を現状より分かりやすく

5. 信頼感・導入事例・メンテナンス性の訴求

  • test/CI/caseバッジ・対応Rails/Rubyバージョン明記・実使用例の追加
  • RubyGemsのdescription未記載も早急に改善

6. エラー出力・型安全の「現実的なレイヤー」の明示

  • runtime型安全 or RBS補助か、どの段階の保証なのかREADME冒頭で触れる

もし必要があれば(次のアクション例)

  • READMEのサンプル刷新
  • 競合(gem)との比較表追加
  • APIドキュメントの拡充

現状もレベルは高く、あと一歩で「Rails params型安全gemの決定版」に近づくと思います。

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions