作品を開く人に、何を見てもらうかを書く
コードは、プログラムなどの処理を書いた記述です。それを渡されても、読む人にはどこから試すのか分からないことがあります。作品の説明書も作ります。GitHubはコード等の変更を管理・共有するサービスで、READMEはそこで最初に読まれることが多い説明ファイルです。公式ガイドも、目的や使い始める方法を記載するよう案内しています。GitHubとは、READMEの案内最初から公開アカウントを作ることを制作の目標にせず、手元のメモでこの説明を書けるようにしてから、共有方法を選べます。
この締切一覧なら、説明の例はこうなります。
- 作った理由:課題を締切の早い順に見たいから
- 使い方:指定の手順でページを開き、用意した三件の表示順を見る
- 自分の担当:一覧と並べ替えを制作。教材を参考にした箇所を記載
- 確認したこと:使った入力と、修正前後の結果
- まだできないこと:入力の保存、通知など、実際の未対応機能
書いた説明だけを見て、作品を閉じた状態から起動してみます。自分が無意識に行った設定や操作が必要なら、その手順を足します。スクリーンショットを添える場合は、どの入力の結果かも付けます。きれいな完成画面一枚より、見てほしい動きが分かります。
公開する前に、学校や共同制作者のルール、教材の利用条件を確かめます。名前やメールアドレス、パスワード、APIキー、利用権限のない画像が入っていないかも確認してください。APIは別のサービスの機能とやり取りする窓口で、APIキーはその利用を認めるための秘密の文字列です。作品の説明に必要なのは使った仕組みで、その秘密の文字列そのものではありません。公開できない作品なら、許可された範囲の説明や画面で伝える方法を相談できます。
AIのコードを使ったら、自分が確認した範囲を話す
ここでのAIは、質問や指示に応じてコードの案を生成する道具です。教材の解答のように、その課題で正しいことが確認済みの答えが返るとは限りません。仕組みをまだ説明できない箇所を見つける助けに使い、最後は同じ入力で実際の動きを見ます。
AIに案を出してもらった場合、提案された処理をそのまま自分の理解した技術として話さないようにします。どこを採用し、どこを変え、どの入力で動作を確認したかを分けて残します。
たとえば、「並べ替えの案はAIに相談しました。月だけを比較していたので年も扱うように修正し、12月と翌年1月の入力で順を確認しました」。実際にそこまで行ったなら、自分の判断と作業が伝わります。理解できていないところは、質問する箇所です。
GitHubのAI生成コードの確認ガイドも、人による確認、目的との整合、動作のテストを重視しています。AIへ「合っていますか」ともう一度聞くだけで、動作確認を済ませないでください。AI生成コードの確認ガイド
選考課題では、応募先が示す外部ツールやAI利用の条件に従います。使ってよい範囲が不明なら、提出物を作る前に問い合わせます。




