はじめに
今回記事の作成にQiita CLIを使ってみようと思って、Qiita CLIのリポジトリを見てみたところ、READMEがすごく見やすかったので、それについて記事化しました。
リポジトリはこちら:
Qiita CLI GitHubリポジトリ
以下に、READMEの良かった点を挙げていきます。
Qiita CLIのREADMEの良い点
見やすさと分かりやすさ
-
記事が文字だけでなくアイコンもあって見やすい
- READMEにはアイコンが使われており、とても見やすく、視覚的に分かりやすい構成になっています
ユーザーへの配慮
-
お願い事項が具体的で、実行しやすい導線がある
- スターをつけるお願いや記事投稿のお願いが書かれており、その内容がすぐに実行できるような導線が用意されています
- Qiita CLIの関連記事がすぐに確認できるようになっている点も秀逸です
情報の充実度
-
使い方やオプションの説明が簡潔で的確
- Qiita CLIの使い方だけでなく、生成されるファイルや各種オプションの内容についても簡潔に説明されており、初めて利用する人にも分かりやすい内容となっています
まとめ
ちょっと簡単な記事ですが、README書く時の参考になれば幸いです。