連載: AIに仕事を奪われる不安から始めるハーネス作成入門
| 回 | タイトル | 状態 |
|---|---|---|
| 第1回〜第20回 | (既刊) | ✅ |
| 第21回 | ハーネス作成をポートフォリオ化する方法 | 📖 |
| 第22回 | Qiita連載とGitHubリポジトリを連動させる運用 | ─ |
| 第23回 | AIハーネスを副業・受託・社内改善に転用する前に考えること | ─ |
| 第24回 | 12週間のハーネス連載を振り返り、次に作るAI基盤を決める | ─ |
はじめに ── 作ったものを「見える化」する意味
ハーネスを作る過程で得た技術や知見は、そのままでは自分以外の人には見えません。ポートフォリオ化とは、その「見えない資産」を他者が評価できる形に整えることです。
SE経験がある方なら、ドキュメント作成や設計書の書き方は既に身についているはずです。そのスキルを、GitHubのREADMEとQiita記事に展開するだけです。
ポートフォリオの3層構造
ポートフォリオを作る際には、3つの層を意識すると整理しやすくなります。
| 層 | 役割 | 置き場所 |
|---|---|---|
| コード層 | 実装とテスト | GitHubリポジトリ |
| 解説層 | 設計意図と学び | Qiita記事 |
| 概要層 | 全体像とスキル | README |
GitHub README構成テンプレート
以下はAIハーネスプロジェクト向けのREADME構成です。そのままコピーして、自分のプロジェクトに合わせてカスタマイズしてください。
# 🧩 プロジェクト名: AIハーネス
## 概要
このプロジェクトが何をするものか、一文で説明します。
## 解決したい課題
- 課題1: ~
- 課題2: ~
## アーキテクチャ
全体の構成図(Mermaidや画像)を置くと見やすいです。
## 主な技術スタック
| カテゴリ | 技術 |
|---|---|
| 言語 | Python 3.x |
| LLM | OpenAI API |
| フレームワーク | FastAPI |
## セットアップ手順
1. リポジトリをクローン
2. 依存関係をインストール
3. 環境変数を設定
4. 実行
## ディレクトリ構成
主要なディレクトリとその役割を簡潔に説明します。
## 関連記事(Qiita連載)
このプロジェクトの設計意図や学びは以下の連載記事で解説しています。
- 第1回: タイトル
- 第N回: タイトル
## ライセンス
MIT License
READMEを書くときの判断基準
「何を書くべきか」に迷ったら、以下の観点で確認してみてください。
| 観点 | 含めるべき | 不要なもの |
|---|---|---|
| 動機 | なぜこのプロジェクトを作ったか | 個人的な感情だけの記述 |
| 技術選定理由 | なぜAを選んだか | 技術の網羅的な一覧 |
| トレードオフ | 何を諦めたか | 「全部できます」という主張 |
| 学び | どこで躓いたか | 成功体験だけ |
Qiita記事との連携戦略
相互リンクの作り方
リポジトリと記事を相互にリンクすることで、読者が「解説→コード」または「コード→解説」と行き来できる構造を作ります。
- READMEからQiitaへ: 「関連記事」セクションに連載リンクを置く
- QiitaからGitHubへ: 記事末尾に「ソースコードはこちら」とリンク
- コミットと記事の対応: 記事公開時に対応するコミットハッシュを記載
リポジトリの「見せ方」の工夫
- トピックを設定: GitHubリポジトリのAbout欄に簡潔な説明を入れる
-
タグを活用:
ai-harness,llm,pythonなど検索されやすいタグ - ピン留め: 特に見せたいリポジトリをプロフィールにピン留め
ポートフォリオの育て方
段階的に充実させる
最初から完璧を目指す必要はありません。段階的に育てていくアプローチがおすすめです。
| フェーズ | やること | 判断基準 |
|---|---|---|
| Phase 1 | READMEと基本コードを公開 | 動作するコードがある |
| Phase 2 | テストとCIを追加 | 品質を示せる |
| Phase 3 | 設計ドキュメントを追加 | 思考過程を見せたい |
| Phase 4 | デモやスクリーンショットを追加 | 動きを伝えたい |
「完成してから」ではなく「作りながら」公開
ポートフォリオは「完成品の展示」ではなく、「成長過程の記録」として価値があります。むしろ、試行錯誤の過程が見える方が、「この人は実際に手を動かしている」という信頼につながります。
SE経験が活きるポイント
- 要件定義 → READMEの「解決したい課題」セクション
- 基本設計書 → アーキテクチャ図
- テスト仕様書 → テストコードとCI設定
- 運用マニュアル → CONTRIBUTING.md
「ドキュメントを書くのは得意だが、見せ方がわからない」という方こそ、ポートフォリオ化のスキルを持っていると言えます。
よくある不安と向き合い方
「コードがまだ汚い」
リファクタリングは後からでもできます。まずは「動くもの」を公開し、改善過程もコミットログで見せましょう。
「見られるのが怖い」
GitHubのリポジトリはPrivateから始めて、準備ができたらPublicに切り替えることもできます。自分のペースで進めれば大丈夫です。
「他の人と比べてしまう」
ポートフォリオは他人との競争ではなく、過去の自分との比較です。「半年前より進歩した」と言える状態が価値です。
まとめ
- ポートフォリオは「コード・解説・概要」の3層構造で整理
- READMEは「動機・技術選定・トレードオフ・学び」の4観点で書く
- 「完成してから」ではなく**「作りながら」公開**する
- SE経験のドキュメント作成力はそのまま活かせる
次回予告
次回 第22回「Qiita連載とGitHubリポジトリを連動させる運用」では、連載記事とコードリポジトリをどう同期させ、継続的に発信していくかの運用ノウハウを紹介します。チェックリスト形式で、すぐに使える運用フローをお届けします。
この記事は連載『AIに仕事を奪われる不安から始めるハーネス作成入門』第21回です。
連載についてのフィードバックやご質問は、コメント欄またはQiitaのDMでお気軽にどうぞ。