PRプログラミング

プログラミングのポートフォリオの作り方｜小さな作品を伝わる形にまとめる

学習したコードがいくつもあっても、何を作ったのかを伝える説明がないと、見た人は試し方に迷ってしまいます。ポートフォリオを作るときは、作品の数を増やす前に、一つの作品の目的と使い方を整理しましょう。

この記事では、読書メモなどの小さな作品をまとめる手順を紹介します。公開しただけで採用や仕事につながると約束するものではありません。自分の学習を振り返り、他の人が内容を理解できる状態を目指します。

誰が何をする作品かを説明する

作品の説明には、技術名より先に使う人と解決したいことを書きます。例えば「読み終えた本を忘れないよう、題名と感想を一覧にする」とすると、必要な機能を考えやすくなります。作った理由と、現在できることを別に示してください。

練習として教材を基にした作品なら、そのことと自分で追加した部分を明示します。借りたコードや画像は、ライセンスと表示条件を確認してください。他人の作品を自分の実績のように見せるより、学習した範囲が伝わる説明を用意しましょう。

機能を絞って完成条件を決める

最初からログイン、共有、通知などを全部作ろうとすると、途中の状態を説明しにくくなります。読書メモなら「題名を入力する」「一覧へ表示する」「空欄のときに案内する」といった一連の操作に絞って作れます。公開する版に含める機能を先に決めましょう。

見た目を整えるときも、使い方が分かることを優先します。ボタンの名前や入力欄の説明が読めるか、狭い画面でも操作できるか、キーボードで必要な操作へ進めるかを確かめてください。作品を使う人が迷った箇所は、次の改善候補として記録できます。

完成条件の例

  1. 練習用の情報で一連の操作ができる
  2. 空欄など想定する入力に案内がある
  3. 保存や削除の挙動を説明できる
  4. 使い方と制限を同じ場所で読める

READMEに試し方と制限を書く

リポジトリへまとめる場合は、READMEに目的、使い方、準備する環境などを書きます。GitHubの公式説明でも、READMEはプロジェクトの内容や始め方を伝えるために使うものとして案内されています。自分以外の人が最初に読むつもりで確認しましょう。

参考：GitHub Docs「READMEについて」

# 読書メモ

## 目的
読み終えた本の題名と感想を一覧にする練習作品です。

## 使い方
1. 題名を入力します。
2. 追加ボタンを押します。
3. 一覧に表示された内容を確認します。

## 制限
この版は画面を再読み込みすると記録が消えます。

## 学んだこと
入力の確認と一覧表示を分けて実装しました。

この例は説明用です。実際の作品が保存できるなら、保存場所と条件へ書き換えてください。動作と説明が食い違っていないか、準備から一度やり直すと確認しやすくなります。スクリーンショットを載せる場合も、現在の画面に合わせて更新しましょう。

公開前に情報と動作を見直す

公開するファイルにAPIキー、パスワード、個人情報が含まれていないかを確認します。Gitで管理した場合は現在のファイルだけでなく履歴へ残っていないかも確認が必要です。公開してよい練習用のデータへ置き換え、共有する範囲を決めてください。

動作確認では、自分がよく使う入力だけでなく、空欄、長い題名、操作を繰り返した場合なども試します。利用者のデータを保存する作品なら、保存や削除の仕組み、案内する内容も考えましょう。初心者の作品でも、扱える範囲を明示すると試す人が判断しやすくなります。

公開後は、直したことと次の改善を短く記録します。例えば「長い題名でも一覧がはみ出さないようにした」といった具体的な記録なら、自分が何を考えて改良したかを振り返れます。作品の数より、一つの目的を説明して改善できる状態を優先してください。

よくある質問

Q. 作品は何個必要ですか？

用途によって求められる内容は異なります。まず一つの作品について目的、操作、工夫、制限を説明できる状態を作りましょう。応募などで使う場合は、相手の指定や役割に合う題材を確認し、数だけを増やさないことが大切です。

Q. 未完成の作品を載せてもよいですか？

学習記録として載せる場合は、現在できることと未対応の部分を明示しましょう。試す人が完成版だと思い込まないよう、操作できる範囲を示します。公開する版と、今後の予定を分けて書くと状態が伝わりやすくなります。

実践前のチェックリスト

  1. 目的と現在の機能を説明した
  2. 公開する版の完成条件を決めた
  3. READMEと動作を照合した
  4. 秘密情報や利用権を確認した
  5. 空欄や長い入力でも確認した

まとめ

ポートフォリオは、作品の目的と使い方が伝わるようにまとめることから始めましょう。小さな機能を完成させ、READMEに操作と制限を書き、公開する情報を確認します。作って終わりにせず、試した結果と改善を記録すると学習の過程も説明しやすくなります。

関連記事