SYSTEM_ROLE = """ You are a helpful assistant that generates clear, well-structured documentation for the given program. """ PROMPT_MAIN = """ 以下は {{language}}言語 で記述されたプログラム `{{script_name}}` のソースコードです。 このコードを解析し、以下の「構成」と「出力形式の絶対条件」に従って、技術ドキュメント(Markdown)を作成してください。 ### 1. 全体要件(厳守) 1. **適切な改行**: 各セクションの間や、見出しの前後には必ず空行(連続した改行)を1行以上挿入してください。 2. **全体をコードブロックで囲わない** 3. **冒頭のタイトル**: 出力の1行目はMarkdownの大見出し # を使った以下の形式とし、直後に必ず1行の空行を入れてください。 # {{script_name}} ドキュメント (ここに空行を入れる) ### 1. 構成案 1. **見出し**: 以下の各章は、Markdownの第二段階見出し ## で始める 2. **プログラムの動作**: プログラムの目的、主な機能、および解決する課題。 3. **原理**: 使用されている数式・物理式やアルゴリズムの解説。 4. **必要な非標準ライブラリとインストール方法**: `pip` コマンド等を含めること。 5. **必要な入力ファイル**: 期待されるファイル形式やデータ構造。 6. **生成される出力ファイル**: 保存されるファイル名とその内容。 7. **コマンドラインでの使用例 (Usage)**: 基本的な実行コマンドと引数の説明。 8. **コマンドラインでの具体的な使用例**: 具体的な引数を与えた実行例とその実行結果の説明。 ### 2. 出力形式に関する絶対条件(厳守) - **禁止記号と代替表記(重要)**: - **三重引用符( `"""` および `'''` )の出力は、いかなる理由があっても厳禁とします。** - プログラミング上の記号として言及が必要な場合は、必ず **「3重引用符」** というテキストに置き換えて記述してください。 - 例:「docstringを3重引用符で囲む」とし、「docstringを """ で囲む」とは書かないこと。 - **数式の共通仕様**: - **インライン数式**: $a^2 + b^2 = c^2$ のように、ドル記号1つで囲む。 - **ブロック数式**: 独立した行に記述し、**その前後は必ず空行で挟んでください。** 例: $$\rho = \frac{\pi d}{\ln 2} \cdot \frac{R_A + R_B}{2} \cdot f$$ - **プログラム名**: マニュアル内では `{{script_name}}` として扱ってください。 --- ### 対象プログラムコード ```{{language}} {{code}} ``` """ PROMPT_LIB = """ 以下は {{language}}言語 で記述されたライブラリ `{{script_name}}` のソースコードです。 このコードを解析し、以下の「構成」と「出力形式の絶対条件」に従って、技術ドキュメント(Markdown)を作成してください。 ### 1. 全体要件(厳守) 1. **適切な改行**: 各セクションの間や、見出しの前後には必ず空行(連続した改行)を1行以上挿入してください。 2. **全体をコードブロックで囲わない** 3. **冒頭のタイトル**: 出力の1行目はMarkdownの大見出し # を使った以下の形式とし、直後に必ず1行の空行を入れてください。 # {{script_name}} ドキュメント (ここに空行を入れる) ### 2. 構成案 1. **見出し**: 以下の各章は、Markdownの第二段階見出し ## で始める 2. **ライブラリの機能や目的**: ライブラリの目的、主な機能、および解決する課題。 3. **importする方法**: このライブラリを他のプログラムからimportする方法。 4. **必要な非標準ライブラリとインストール方法**: `pip` コマンド等を含めること。 5. **importできる変数と関数**: 変数には説明するコメントを、関数には関数の動作と引数・戻り値の説明を入れること。 6. **main scriptとして実行したときの動作** ### 3. 出力形式に関する絶対条件(厳守) - **禁止記号と代替表記(重要)**: - **三重引用符( `"""` および `'''` )の出力は、いかなる理由があっても厳禁とします。** - プログラミング上の記号として言及が必要な場合は、必ず **「3重引用符」** というテキストに置き換えて記述してください。 - 例:「docstringを3重引用符で囲む」とし、「docstringを """ で囲む」とは書かないこと。 - **数式の共通仕様**: - **インライン数式**: $a^2 + b^2 = c^2$ のように、ドル記号1つで囲む。 - **ブロック数式**: 独立した行に記述し、**その前後は必ず空行で挟んでください。** 例: $$\rho = \frac{\pi d}{\ln 2} \cdot \frac{R_A + R_B}{2} \cdot f$$ - **ライブラリ名**: マニュアル内では `{{script_name}}` として扱ってください。 --- ### 対象プログラムコード ```{{language}} {{code}} ``` """