More than 3 years have passed since last update.

【Github】のReadmeを修正した話

Last updated at 2021-10-01Posted at 2021-09-28

今回使ったReadMe

#1. はじめに

上記の記事を見ていただいた方が勉強になると思います

#2. 経緯
ポートフォリオのReadMeを作ったところ、読みにくいと言われたので色々調べて作り直すことにした

その前後に調べたことをまとめて備忘録として残す・・・のは次回です

今回は自分のPFを修正した部分だけに焦点当ててます
#3. わかりにくさ？
変更前の自分の Read Me

わかりやすいように画像を使い矢印を配置し端的に作った！・・・つもり

ただし、何人かに聞いたところ評価は読み辛いだった

くどいのかな？

あと、誤字・・・使用と仕様はOUT!
#4. わかりやすさ？
絶対にいるよねって項目は置き

説明はできるだけ簡潔に、なんなら動画でもいいのかもしれない
#5. 今回の例
つまるところ自分のPF

正直な話ペラ・・シンプルな内容のアプリです

だから余計な説明は必要なく最低限にしようねってことで

メイン（動画）
- 画像はまとめて動画（中に説明要素も込めた）にし目につくよう一番最初に正面で＋２倍速
Title
- タイトルは必須
サブ (Package画像)
- 目玉になる技術は画像で並べる
Description
- 説明はほんの少し興味を持ってもらえた場合は読んでもらえそうな量に
Play here
- アプリのURLはUsage にしていたけどもっとわかりやすくていいよねってことでPlayHere
Package
- ここは無くてもいいかもしれない、画像で載せたし、でも、typescript って書きたかった・・・
Note
- ここは備考欄　作る上で意識したこと
Reference Links
- 　参考リンク　のこと　全部別ページに避け１行に
修正後の自分の Read Me

結構書かれているように見えるけど実物を見ると

マウスホイール一回分くらにも満たないかと

（ホイールの設定色々あるけど）・・・

とはいえスッキリしたんじゃないかな！？
#6.　まとめ　
項目数はコンテンツのボリューム（重さ）に合わせるべき

恐らくここじゃないかと

簡易なアプリやコンテンツであれば余計な説明は不要！
内容のみっちり詰まったものなのであれば,
それに合わせて説明文はしっかり入れるべき、端折られると使い方がわからない

#7. おわりに
修正しましたがこれが良い例かはわかりません
ただ、見やすくするという意味では
前より短くアイコン・画像が多いので読むというより流し見れる
のでうまくいったのではと
ただちょっとgif動画の画面大きすぎるかもしれない
ご意見あれば宜しくお願い致します