エンジニアのポートフォリオは、作ったもののリンク集だけでなく、何を目的に、どこを自分が担当し、どんな判断をしたかを伝えるために使えます。作品数を増やす前に、読み手が一つの成果物を理解できる説明を整えましょう。
完成画面・ソースコード・READMEを、同じ目的を説明する材料としてつなぐと、確認してほしい点を示しやすくなります。ただし、応募先が求める提出物や公開方法は募集内容を優先してください。
READMEには、最初に知ってほしいことを書く
GitHubはREADMEを、プロジェクトでできること、有益な理由、使い始め方などを伝えるための文書として説明しています。リポジトリを開いた人が内容を理解する入口に使えます。出典:GitHub Docs
ポートフォリオ用に整えるなら、目的、主な機能、自分の担当範囲、動かし方、工夫した点、残っている課題を説明する構成が考えられます。すべてを長く書く必要はありません。読み手が最初に概要をつかみ、必要に応じて詳細へ進める順序を意識します。
たとえば「タスク管理アプリを作りました」だけでは、何を見てほしいかが分かりません。「複数の担当者が期限と状態を共有するための試作で、更新競合時の扱いを検討した」と書けば、画面や設計のどこに注目すればよいかを伝えられます。これは説明用の架空の制作例です。
自分の担当と、使ったものを分ける
チーム制作なら、全体像を説明したうえで、自分が実装・設計・検証した範囲を明記します。他のメンバーが作った部分まで自分の成果として見せないことが大切です。
個人制作でも、教材、テンプレート、ライブラリ、生成AIなどを使った部分と、自分で変更して確かめた部分を整理できます。補助を使ったことを隠すより、どの問題を自分で判断し、動作をどう確認したかを説明しましょう。利用したコードや素材は、公開・再配布の条件も確認してください。
職務で扱ったソースコードや顧客データを、そのまま成果物として公開する必要はありません。公開できる範囲は勤務先や契約上の条件によって異なります。許可が不明な資料は出さず、一般化した説明や、機密情報を含まない独自の試作で示せる内容を考えます。
動かし方は、別の環境で読んで試せる内容にする
成果物の説明と実際の状態がずれていると、読み手は判断に迷います。READMEには、前提となる実行環境、準備する設定、起動方法、動作を確認する操作を記載する方法があります。
以下は、説明の粒度を考えるための例です。
| 項目 | 読み手が確認できる状態 |
|---|---|
| 前提 | 必要な言語・実行環境のバージョンが分かる |
| 設定 | 設定名と用途が分かり、実際の秘密情報は含まれない |
| 起動 | 手順の順番と、成功時に何が見えるかが分かる |
| 確認 | サンプルデータで試せる操作と期待する結果が分かる |
| 制約 | 未実装の機能や、試していない環境が分かる |
書いた手順を、普段の環境に依存しない状態で確認できる範囲で試しましょう。公開デモを用意する場合も、停止中ならその状態を説明します。デモがない場合は、画像や操作の記録で何を確認できるかを補足できますが、実行可能なデモと同じものとして扱わないでください。
工夫は、機能名より判断の理由で説明する
「認証を実装した」「テストを書いた」だけでなく、なぜその設計にしたのか、何を確認したのかを一つ掘り下げます。
仮に一覧画面の検索機能を作ったなら、入力が空の場合、該当するデータがない場合、不正な値が送られた場合をどう扱ったか説明できます。性能を改善したと書くなら、比較した条件や測定方法を示し、測っていない効果は断定しません。
未解決の課題も、次に何を確かめるかまで書ければ、作品の状態を正確に伝える材料になります。「すべて完成」と広く主張するより、実装済みの範囲と未確認の範囲を区別してください。
応募先との接点が分かる成果物を選ぶ
すべての応募で同じ順番に並べるのではなく、募集内容との接点があるものを先に示す方法があります。インフラ運用の仕事なら構成や復旧手順、アプリ開発なら機能と設計判断など、読み手に伝えたい点を考えます。応募先が必ず特定の項目を評価すると決めつけるものではありません。
職務経験を伝える資料との役割も分けましょう。職務経歴書は担当した仕事の範囲を説明し、ポートフォリオは実物や設計の説明で補う、と整理できます。詳しくはエンジニアの職務経歴書も参考になります。
テクノヴァースへの応募を検討する方は、採用情報で現在の職種や提出内容を確認してください。ポートフォリオの有無だけで判断するのではなく、担当できることを正確に伝える材料として準備しましょう。