これまで構築してきたプログラムに関するレポートを作成してください。 以下にレポートの構成を示しますので、これに準拠してください。
(プログラムの提供する機能が想像できるタイトルをつけること)
今回のプログラムを作成するに至った背景、プログラムの目的と概要などを記述する。
今回作成したプログラムに関連する技術の動向について簡単に述べる。
システムを使う立場からみて、何ができるシステムなのかを記述する 具体的な使用方法についてもここに記述する。内部的な動作についてはここには記述しない。
特定の条件の下で動くことを前提としている場合には、それも明示する。 例えば、URL の入力を受け付けるが正しく動作する URL は限られている、 災害時でないと何も出力されない、といった場合など。
プログラムが完成していない場合には、どこまでの機能が実現していて、 どこからが未実装なのか明確にすること。
システムが外部のリソースを利用する場合には、 各リソースについて以下の内容を記述する。
Web API (Webサービス) を利用している場合には、 リクエストのパラメータ、およびレスポンスの構造について、 プログラムで利用している範囲において記述すること。
生成AIを利用している場合も、API を介してアクセスしている場合には上記に準じて記載すること。 リクエストについてはプロンプト等を含めること。 プロンプトを動的に生成している場合には、その指示と例を示すこと。
生成AIを介して何かにアクセスしている場合には、それもリソースとして扱うこと。 入出力(リクエスト/レスポンス等)についてはわかる範囲で記述すること。
プログラムの構成について記述する。 まず全体のおおまかな構成を示し、 その後に主なクラスの役割と、クラス間の関係について説明すること。
外部プログラム等を利用している場合には、その役割について記述すること。
どのような情報を格納するのにどのようなデータ構造を用いたか、 および、そのデータ構造とどのようなアルゴリズムを組み合わせて機能を実現したか、 詳しく説明すること。 データベースを利用した場合は、各テーブルの役割について説明すること。
どこで行っている処理が知的処理なのか明確にし、知的処理の内容を詳述すること。
あれば記述する。
設計・実装に用いた環境やツールを記載すること。 生成AIを利用した場合には利用サービス・利用方法について詳述すること。
プログラムを動作させ、その結果を報告すること。
プログラムの入力について説明すること。 データを入力とする場合には、データの件数、データの時間範囲など、 データの持つ性質に即した説明をすること。 ライブラリや外部ツールの version についても記載すること。 生成AIについてはモデルの情報を記載すること。
出力内容、実行画面などを示すこと。 うまくいった例とうまくいかなかった例があるとよい。
性能についての定性的・定量的評価があればなおよい。 客観評価としてデータ抽出の成功率、主観評価として使用者の満足度などがある。
以下の項目について考察すること。
実現した機能は適切だったか、どのような改良が考えられるか。
プログラムの構造、用いたデータ構造、アルゴリズムは適切だったか。 効率の面ではどうか。
そもそものリソースの選択は適切だったか。リソースを有効に利用できたか。
レポートのまとめ、今後の展開、など。
正式なレポートでは感想は不要だが、ここでは思うところを好きに記述してよい。
このレポートを読む人が、 レポートの内容を理解したり、 関連する情報を知りたいときに参照すべき文献やWebページなどがあれば列挙すること (自分が参考にした文献ではなく、読む人が参考にすべき文献であることに注意)。 一つの項目につき、著者、タイトル、本なら発行元、WebページならURL、は必須とする。
ファイルの形式は HTML文書(.html), Word文書(.docx) のいずれかとする。