エンジニアの履歴書と呼ばれるREADMEを初めて書いてみた。

GitHubのREADMEは、エンジニアにとっての履歴書と呼ばれています。

そもそもREADMEには何が書かれているものなのかというと、そのプロジェクトがどのようなもので、どうやって使うのかという使用法。

大雑把にいうと、Amazonでの商品紹介と、商品自体の説明書が一緒になったものと考えて良いかと思います。

日本語、英語のどちらでも書くことができますが、統一したほうがよいと思ったので英語で書きました。

英語の勉強にもなりますし、英語で分かりやすい説明を書くことができれば、それだけで英語力の証明になると思ったからです。

READMEを書くベストな手段

最初は自分のMacにCloneしたREADMEに書きこもうかと思いましたが、それではいちいちGitHubに反映させないとプレビューが見れずに不便ということに気づきました。

GitHub上でダイレクトにREADMEを修正すれば、プレビューを見ながら編集することができるので便利です。

READMEはパッと見の分かりやすさが重要なので、このプレビューを見ながら編集ができるというのは編集スピードが上げるためにとても大切です。

参考にしたREADME

はじめてREADMEを書くには、優れたお手本を参考にするのが一番手っ取り早いです。

ぼくが参考にしたREADMEはPacmanゲーム。

このREADMEは画像も豊富で読みやすく、途中にレインボーの線も入っており、無味乾燥になりがちなREADMEに華を添えています。

上記のREADMEはAwesome READMEという、優れたREADMEが集められたまとめサイトで見つけました。

README.mdの書き方についてまとめ

まだREADMEを書き始めたばかりですが、README.mdの書き方についてZennにまとめました。

いままで、ウェブで仕入れたちょっとした知識は、Notionにウェブクリッピングして、あとで見返すということをやっていましたが、結局見返さず、検索ですましてしまうことが多いです。

そして、いざ見つけようと思っても検索で見つからなかったり、Notion上で見つけるのに時間がかかったりもします。

そんなちょっとした知識の集積所としてZennはちょうど良く、学んだことをリアルタイムで整理し、アウトプットすることができます。

自分が読む用の覚書なので、無味乾燥としていますが何度も見返し、追加で有用な知識があれば、その場でアップデートができるので実用度は高いです。

引き続き活用していこうと思います。

▼ 直近の人気記事


▼ 42 Tokyoについて