READMEはこう書く！僕のポートフォリオ記録

2021.01.11
programming

ポートフォリ制作において、READ MEの記述は、自身の制作物の説明書、仕様書、設計図のようなもの。アピールの場としてもとても重要。でも、 READMEって、どうやって書いたらいいの？マークダウン記法って何？

こんな疑問に答えていきます。

信頼性:
エンジニア転職を目指し、毎日平均10時間ほど、プログラミング学習に励んでいます。

この記事を読むと実現できる事：
READMEに書くべき内容、マークダウン記法の基本について知ることができます。
書き方で悩んでいる方がいましたら、少しでもお役に立てたら嬉しいです。なお、ここで紹介する書き方は一例ですので参考までに。

1. READMEに書く内容一覧
- 1.1. 僕が記述したREADMEはこちらです。
2. マークダウン記法
- 2.1. マークダウン記法の基本

READMEに書く内容一覧

READMEは、あなたの制作物（ポートフォリオ）の説明書のようなもの。
だから、簡潔にわかりやすく書く事が大事です。 
とは言っても、どのような内容を書いたら良いのかわからない方のために、記述することの一覧をあげました。

記述すること	備考
アプリケーション名
アプリケーション概要	このアプリケーションでできることを記述します。
URL	デプロイ済みのURLを記述します。
テスト用アカウント	ログイン機能等を実装した場合は、またBasic認証等を設けている場合は、そのID/Passも記述します。
利用方法	このアプリケーションの利用方法を説明します。
目指した課題解決	このアプリケーションを通じて、どのような人の、どのような課題を解決したかったかを書きましょう。ここがアピールポイントになるかと思います。
洗い出した要件	要件定義を、マークダウンで記述します。
実装した機能についてのGIFと説明	実装した機能について、それぞれどのような特徴があるのか列挙します。GIFを添えることで、イメージがしやすくなります。
実装予定の機能	洗い出した要件の中から、今後実装予定のものがあれば記述しましょう。
データベース設計	ER図等を添付しましょう。
ローカルでの動作方法	git cloneしてから、ローカルで動作をさせるまでに必要なコマンドを記述しましょう。この時、アプリケーション開発に使用した環境を併記することを忘れないでください（パッケージやRubyのバージョンなど）

僕が記述したREADMEはこちらです。

参考までに、僕が記述したREADMEの一部です。

リードミーの一例

アプリケーション名
「リクエスト・シェフ」

アプリケーション概要
料理を作って欲しい人と、料理を作りたい人をマッチングするアプリケーションです。

URL
https://request-chef.herokuapp.com/　
（こちから私の制作物に遷移できますが、ダミーですので、個人情報等は入力しないで下さい。）

テスト用アカウント
メールアドレス： y@y 
パスワード : yyyyyy1

利用方法
シェフ側：新規登録をして、「シェフさん新規登録」にて、自身のプロフィールなどを登録します。
 ユーザー側: トップページにて、シェフさん一覧より依頼したいシェフさんの詳細ページへ遷移し、内容を確認します。その後、依頼ページ遷移し、クレジットカード情報、依頼者の住所などを登録したら依頼ができます。

目指した課題解決
調理技術を持ったシェフがそのスキルを生かして収益をあげる事と、ご自宅でそのスキルを生かして自分のために料理をして欲しいという、ユーザーのニーズを満たすことを目指しました。

洗い出した要件定義
要件定義表
https://gyazo.com/2ea775e39985d337dc87ac1838c067dd