RubyのGemを作成していますが、YARDやRdocの見本となるGemを教えてください

Question

RubyのGemを作成しています。

RdocやYARDの使い方は理解しましたが、具体的に何を
書くべきなのか。
正しい書き方、省略できる項目があるのか、
などドキュメントを書く指針がわかりません。

参考になるGemがあれば教えてください。

Answer 1

なんというか凄いなと感じるのは

rubicure

Answer 2

webmock は丁寧に書いていると思います。

• bblimke/webmock: Library for stubbing and setting expectations on HTTP requests in Ruby.

gemの雛形を作成するbundler gem コマンドが生成するREADMEには下記の7つが書いてあります。

1. gemの説明
2. gemのインストール方法
3. gemの使い方
4. gemの開発の始め方
5. gemへの貢献の方法
6. gemのライセンス（OSSとして公開するのであれば必須）
7. 行動規範（Code of Conduct）

上から読んでいけば、

• gemが何をするものかがわかり、
• gemを導入することができて、
• gemを使ったコードが書けるようになり、
• gemのバグを見つけたりした場合に、gemを開発することができ、
• 開発した内容を元のリポジトリにフィードバックする方法がわかり、
• フィードバックがどのように扱われるかがライセンス、行動規範により理解できる

ようになります。