Pythonプログラム解析・ドキュメント生成・プログラム最適化プロンプト
【概要】 Pythonプログラムの解析から文書化,コード最適化までを一貫して実行する包括的なプロセスのプロンプト.用語リストの作成,プログラム概要の作成,使用方法の説明,仕様書の作成,PEP8準拠のコード生成という5つの主要な成果物を23のステップで体系的に生成し,各ステップで品質管理を行う.
Claude.AI用(https://claude.ai/chat)
プロンプト(Claude.AI用)
このプロンプトは,Pythonプログラムソースコードを解析し,包括的な文書化を行うための詳細な指示である.主な機能として,重要用語の抽出と説明,プログラム概要の作成,使用方法の説明,仕様書の作成,そしてPEP8準拠のコード整形を行う.プロンプトの特徴は,実行手順と品質基準を定義していることにある.各ステップで必要な確認事項が明確に示されている.
このプロンプトは,ソフトウェアプロジェクトやチーム開発での活用を想定している.特に,プログラムの保守性向上,チーム内での知識共有,新規メンバーの教育支援などの場面で効果を発揮する.実践的な応用例として,オープンソースプロジェクトのドキュメント作成,技術マニュアルの整備,社内研修資料の作成などが挙げられる.
期待される効果として,プログラムの理解容易性の向上,開発チーム内でのコミュニケーション効率化,保守作業の効率化,品質管理の強化などがある.また,標準化された文書作成プロセスを通じて,組織全体の技術文書の質的向上も期待できる
Claude.AI用(https://claude.ai/chat)
# タスク仕様書
## 1. 目的
人間から与えられたPythonプログラムソースコードなどを解析し,以下の成果物を作成する:
- 用語リスト:15~20個の重要用語(各用語に100~150字の説明文を付記)
- プログラム概要:主な機能,技術的な特徴,機能面の特徴,実行時の注意事項を説明する有用な情報(全体で170文字以内)
- プログラムの使い方:必要なインストール,必要な前準備,プログラムの起動と利用を説明する有用な情報(Windows環境を想定した説明)(箇条書き.具体的に)
- プログラムの仕様書:プログラムの目的,プログラム利用を想定しているケースと期待される効果,実行時の注意事項,実践的な応用例を含むプログラムの総合的な仕様書(マークダウン形式)
- 修正されたプログラム:PEP8に準拠のPythonプログラム.コメントとエラーメッセージと docstring は日本語.表示では,単一のファイル(「```」の使用を禁止).
## 2. 実行者の行動規範
- プロフェッショナルな文章作成者として振る舞う
- 優秀なITエンジニア,AIエンジニア,データベースエンジニア,プログラマとしての知見を活用する
- 与えられたプロンプトを正確に実行する
- データの取り扱いは適切に行い,簡略化・省略は行わない
- 正確性とロジカルシンキングを常に意識する
- 実行手順は必ず1ステップずつ着実に遂行し,複数ステップの一括実行はしない
## 3. プロンプト解析規定
- プロンプトの内容を完全に理解する
- プロンプトの要件を漏れなく把握する
- プロンプトの意図する成果物を明確にする
- プロンプトの制約条件を遵守する
## 4. コミュニケーション規則
- 使用言語:日本語
- 句読点:「,」「.」を使用
- 文体:「である」調を基本とする
- 情報提示:可能な限り一括して表示
- 情報表示の抑制:実行手順で指定された表示のみを行う.表示する際は,正確性と簡潔性を保持する
- コード表示:「```」や「python ```」などの記法は使用しない
- ステップ遂行:ステップは1つずつステップバイステップで進める.人間からの承認を待たず,「実行手順」の次のステップへ進む
## 5. 実行手順
### ステップ1:準備フェーズ
- プロンプト全体を精読し,内容を完全に理解する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ2:人間から与えられたPythonプログラムソースコードなど精読
- 人間から与えられたPythonプログラムソースコードなどのすべての内容を深く読み込み,最初から最後まで完全に理解する
- 人間からPythonプログラムソースコード以外の説明が与えられている場合は,それを含め,すべての内容を深く読み込み,最初から最後まで完全に理解する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ3:Pythonソースコードからの用語抽出作業
- ステップ3では,人間から与えられたPythonプログラムソースコードのみを使用する
- 人間から与えられたPythonプログラムソースコードから以下に関連する重要用語を15~20個抽出する:
- プログラムの特徴的な機能に関係するAI技術,IT技術
- プログラムで使用されている高度なAI技術,IT技術
- 抽出するのは用語のみで,今のステップでは説明文は必要ない
- 重要度と有用性を基準に選定を行う
- 用語の過不足を確認し,問題があれば対処する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ4:用語の配列調整
- 用語を以下の基準で並べ替える:
- 基本事項から応用事項への順序性
- 用語間の関連性への配慮
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ5:用語リスト内の説明文作成
- 各用語について説明文を作成し,用語リストを作る
- 説明文の文字数:100~150字
- 表現は人間から与えられたPythonプログラムソースコードなどに準拠する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ6:補足情報追加
- 用語リストの全説明文に,人間から与えられたPythonプログラムソースコードなどをもとにして,以下の補足情報を括弧書きで追記する:
1. 具体例
2. 数値データ
3. 根拠となる情報
4. 難解な用語の最小限の補足説明
- その他,高度な内容には,必要最小限の補足説明を括弧書きで追加する
- 追記情報は単独で理解可能な形式とする
- 人間から与えられたPythonプログラムソースコードなどを参照する表現は使用しない
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ7:説明文の最適化
- 用語リストの全説明文を見直し,括弧書きの内容を可能な限り本文に組み込む
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ8:用語リストの確認・修正
- 用語リストの全説明文の正確性を人間から与えられたPythonプログラムソースコードなどと照合し,必要に応じて修正する
- 用語リストの全説明文の一貫性を確認し,必要な修正を加える
- 説明文の中の高度な内容すべてについて,必要最小限の補足説明(例:例示)を括弧書きで追加する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ9:用語リストの学術的正確性の確認
- 全説明文を学術的知見に基づいて確認する
- 確認により不正確な説明が発見された場合には,必要最低限の修正を実施する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ10:用語リストの表示
- 句読点(「,」「.」)の使用を確認・修正する
- 「である」調の使用を確認する
- 表示はアーティファクトに行わないこと(重要)
- 以上の確認後,用語リストを番号付きリストで表示する
- 表示は途中で止めずに,なるべく長く表示する
- 作成した用語リストは,ステップ11とステップ14で使用する
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ11:プログラム概要の原案作成
- 用語リストと人間から与えられたPythonプログラムソースコードなどから,以下の内容を具体的に説明する
- プログラムの主な機能
- プログラムの技術的な特徴
- プログラムの機能面の特徴
- プログラムの実行時の注意事項
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ12:プログラム概要の推敲,170文字以内にまとめ
- ステップ11のプログラム概要は,論理的な文章の流れに整理する
- さらに,理解しやすい構成に調整する
- さらに,再構成し,170字以内の1段落にまとめる
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ13:プログラム概要の確認と表示
- ステップ12のプログラム概要は,人間から与えられたPythonプログラムソースコードなどと照合し,正確性を確認する
- 句読点(「,」「.」)の使用を確認する.必要最低限の対処を行う
- 「である」調の使用を確認する.必要最低限の対処を行う
- 表示はアーティファクトに行わないこと(重要)
- 作成したプログラム概要を人間へ表示する
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ14:プログラムの使い方の原案作成
- Windows環境でのプログラム利用を前提に,プログラムの使い方を説明
- 用語リストと人間から与えられたPythonプログラムソースコードなどから,以下の内容を具体的に説明する
- 必要なインストール
- 必要な前準備
- プログラムの起動と利用を説明する有用な情報
- プログラムの表示が高度な内容である場合は,その簡潔な説明
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ15:プログラムの使い方の確認と表示
- ステップ14のプログラムの使い方は,人間から与えられたPythonプログラムソースコードなどと照合し,正確性を確認する
- 句読点(「,」「.」)の使用を確認する.必要最低限の対処を行う
- 「である」調の使用を確認する.必要最低限の対処を行う
- 作成したプログラムの使い方を人間へ表示する
- 表示はアーティファクトに行わないこと(重要)
- 表示は途中で止めずに,なるべく長く表示する
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ16:プログラムの仕様書の原案作成
- 用語リストと人間から与えられたPythonプログラムソースコードなどから,以下の内容を具体的に説明する:
- プログラムの目的
- プログラム利用を想定しているケース
- プログラム利用の期待される効果
- 実行時の注意事項
- 実践的な応用例
- プログラムの仕様書は,マークダウン形式で作成する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ17:プログラムの仕様書の推敲
- ステップ16のプログラムの仕様書は,論理的な文章の流れに整理する
- さらに,理解しやすい構成に調整する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ18:プログラムの仕様書の確認
- ステップ17のプログラムの仕様書は,人間から与えられたPythonプログラムソースコードなどと照合し,正確性を確認する
- 句読点(「,」「.」)の使用を確認する.必要最低限の対処を行う
- 「である」調の使用を確認する.必要最低限の対処を行う
- 表示はアーティファクトに行わないこと(重要)
- 作成したプログラムの仕様書を人間へ表示する
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ19:プログラムコードのPEP8準拠への変更作業
- 人間から与えられたPythonプログラムソースコードをPEP8に準拠するように変更する
- エラーメッセージは日本語に変更する
- コメントは日本語に変更する
- docstring は日本語に変更する
- 本ステップでは結果についての表示を行わない
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,人間からの承認を待たずに,次のステップに移行する
### ステップ20:修正されたプログラムの確認と表示
- ステップ19のプログラムコードは,人間から与えられたPythonプログラムソースコードと照合し,機能の同一性を確認する
- 表示はアーティファクトに行わないこと(重要)
- 作成した修正プログラムを人間へ表示する
- このステップを終了するときに,結果の正確性を再確認する.そしてステップ番号を表示する.そして,プログラムの解析作業は終了である
実行結果例
AI にプログラムを与えることにより, 用語リストの作成,プログラム概要の作成,使用方法の説明,仕様書の作成,PEP8準拠の最適化されたコード生成を行う.AI に与えたプログラム
print("hello world")
AI からの出力
- 用語リスト
- print関数: Pythonの基本的な出力関数であり,指定された引数をコンソール画面に表示する機能を持つ.文字列,数値,変数など様々なデータ型に対応し,デフォルトでは出力後に改行が追加される(例:print("Hello")は"Hello"を表示して改行する).
- 文字列リテラル: プログラム中に直接記述される文字の並びで,Pythonではシングルクォート(')またはダブルクォート(")で囲んで表現する.文字列の中身はUnicodeとして扱われ,日本語などの多言語表示が可能である(例:"hello world"は7文字の文字列リテラル).
- コンソール出力: プログラムが実行結果やメッセージを表示するための標準出力画面のこと.テキストベースのインターフェースを提供し,print関数による出力先となる(例:Windows環境ではコマンドプロンプトやPowerShellが該当する).
- Unicode: 世界中の文字を統一的に扱うための文字コード規格.Pythonの文字列は内部的にUnicodeとして処理され,世界各国の言語を扱うことができる(例:ASCII,日本語,絵文字など約14万文字に対応).
- 改行コード: テキストの行の区切りを示す特殊な文字.環境によってLF(\n),CR(\r),CRLF(\r\n)が使用され,print関数は自動的にプラットフォームに適した改行コードを出力する(例:Windowsでは\r\nが使用される).
- プログラム概要
コンソール画面に"hello world"という文字列を出力する基本的なPythonプログラムである.print関数を使用して標準出力を行い,出力後は自動的に改行される.Unicode対応により多言語での出力が可能であり,Windows環境で実行可能である.
- 使用方法の説明
1. 必要なインストール - Python 3.x(最新版推奨)をWindows用にダウンロードし,インストールする - インストール時に「Add Python to PATH」にチェックを入れる 2. 必要な前準備 - テキストエディタでプログラムを作成し,.py拡張子で保存する - プログラムの文字コードはUTF-8を使用する 3. プログラムの起動と利用 - コマンドプロンプトを起動する - プログラムが保存されているフォルダに移動する - 「python プログラム名.py」を実行する - "hello world"が表示され,自動的に改行される
- PEP8準拠の最適化されたコード
```python #!/usr/bin/env python3 # -*- coding: utf-8 -*- """ シンプルな挨拶を表示するプログラム. 標準出力に"hello world"という文字列を出力する. """ def main(): """ メイン関数:hello worldを出力する. """ try: print("hello world") # 挨拶文を出力 except Exception as e: print(f"エラーが発生しました:{e}") # エラーメッセージを日本語で表示 if __name__ == "__main__": main() ```
- 仕様書
# プログラムの仕様書 ## 1. プログラムの目的 標準出力に"hello world"という文字列を出力する基本的なPythonプログラムである. ## 2. プログラム利用を想定しているケース - Python言語の基本的な出力方法を学習する際の練習用 - プログラムの動作確認やデバッグのテスト用 - 環境設定の確認用 ## 3. 期待される効果 - 標準出力機能の理解 - 文字列処理の基本的な理解 - エラーハンドリングの基本的な理解 ## 4. 実行時の注意事項 - Python 3.x環境が必要 - 文字コードはUTF-8を使用 - Windows環境での実行を想定 ## 5. プログラムの解説 - シバン(#!/usr/bin/env python3)とエンコーディング(# -*- coding: utf-8 -*-)を指定 - main関数でプログラムの主処理を実行 - try-except文でエラーハンドリングを実装 - エラーメッセージは日本語で表示 ## 6. 実践的な応用例 - 各種言語での"hello world"出力 - ログ出力の基本形として利用 - システム状態の確認用として利用