More than 3 years have passed since last update.

READMEを作成してみて

Posted at 2021-09-10

はじめに

本記事では、READMEを作成した際に思ったことや、必要だと感じたことを現時点でまとめました。

オリジナルアプリの作成が最低限終わりデプロイ後、READMEを作成しようと思いましたが、
そもそもREADMEの役割がなんなのか理解不足でしたので調べました。

Readmeとは、ソフトウェアを購入する際に添付されている、ソフトウェアの利用前に読んでおくべき内容が記載されたファイルのことです。単にソフトウェアの説明書と理解しても問題ないでしょう。

簡略化された説明書ということですね。
万が一転職する際などでREADMEが雑ですと、
読み手もアプリケーションに興味を持つことができないため、その時点で選考に落とされてしまいます。

説明書がないアプリケーションを見る気にはなりません。

ですので、READMEにも力を入れるべきですね。

①アプリケーション名
②アプリケーション概要
③ペルソナ
④作者
⑤各テーブルの説明

だと思いました。

名前をつけることでアプリケーション自体に価値観が生まれると思います。
また、トップページの名前が記載されている画像を添付しても良いと考えています。

簡単にどのようなアプリケーションなのかを記載する必要があります。
これを記述することで、面談時などの相手と話す内容も濃いものになると考えています。

誰の何のために作ったのか、が明確にできていないとアプリケーションを作った経緯が見えません。
その背景も相手に伝えることが良いと思います。

シンプルに私です。
また、QiitaやTwitterで毎日発信しているところがここで良い方向に働くのではないかと考えています。
少なくとも、エンジニアとしての自分が持っている情報を記述する必要があります。

各テーブルの機能の動画やカラムなどを記述します。
特にわかりやすく動画を載せるのが良いと思います。

①取り扱った言語の記載
②さらに細かい概要の説明

①については、取り扱っている言語のパーセンテージがGithubに載っているからなあと考えています。
また載せるからには、各言語のロゴなどを表示しておしゃれにしたいです。

①画像と動画を入れてREADMEを色つけした。
カラフルな方が読みやすいと考えました。
また読むよりも見る方が読み手にストレスなくアプリケーションの紹介ができ、良いのでは？と考えています。

②絵文字の活用
少し迷いましたが、これも①同様に絵文字を入れることで、より一層読みやすくなるのではないかと思い、絵文字も入れております。

今のところ思ったこと、気づいたことは以上です。

READMEはやれば１日かからずオシャレに仕上げることができると思います。
また転職時などでは、アプリケーションの良さを伝えるためには、かなり重要になるのではないかと考えます。

最低限オリジナルアプリができたと言えどまだまだ改善の余地はありますので、
改善でき次第、READMEもオシャレに仕上げていきたいなと思います。

特に３つ目の記事は、とても参考になる記事だと思います！！

ここからは蛇足です。
本日9月10日、私が入校したテックキャンプを無事に卒業できました！
特にチームのメンバーは心の支えでしたし、プログラミングが楽しいと思えた最大の理由であったと思っています。

それぞれ駆け出しエンジニアとしてスタートしたばかりですが、
これからのエンジニアライフを全力で楽しんでいきましょう！
この記事を見られているかはわかりませんが、またご縁があればよろしくお願いします！！

それでは、明日からも頑張りましょう！！！！