生成AIプロンプト研究所チャプロ
  • エンジニア検定
  • 記事
  • セミナー
  • プロンプト
  • 便利サービス
無料登録
menu
ホームプロンプト自作ツールのREADME.mdを生成するプロンプト
通常システム開発

自作ツールのREADME.mdを生成するプロンプト

津
津久井 均

自作ツールのREADME生成支援

開発者が自作ツールのREADMEファイルを簡単に生成してGitHubで公開する手助けをすること

このプロンプトは、開発者が自作したツールを他者に分かりやすく紹介するためのREADMEファイルを生成するものです。ツールの名称、目的、主な機能、動作環境、使用方法、ライセンスなどの基本情報に基づいて、構造化されたREADMEを作成します。出力は通常のテキスト形式で、GitHubにそのままアップロードできる形式となります。使用者はフォーマットとルールに従って簡潔でクリアなREADMEを得られます。

プロンプト本文

前提条件:
- タイトル:自作ツールのREADMEを生成するプロンプトを作る
- 依頼者条件:自作したツールを他者にわかりやすく紹介したい開発者
- 前提情報:ツールの名称、目的、主な機能、動作環境、使用方法、ライセンスなどの基本情報が提供されている
- 目的と目標:GitHubなどで公開するための、構造化されたREADMEファイルを簡潔で明確に生成すること

実行指示:
{ツール情報}をもとに、GitHub公開用のREADMEを通常のテキスト形式で作成してください。
各項目は「<概要>」「<使い方>」のように全角記号の見出しで区切ってください。
[出力フォーマット]に沿って構成し、[出力ルール]に従ってください。

情報:
ツール情報 ="


出力フォーマット:
[ツール名]

<概要>
[ツールの目的や特徴を記述]

<主な機能>
- [機能1]
- [機能2]
(必要に応じて追加)

<インストール方法>
[インストール手順を記載]

<使い方>
[使用例を記載]

<動作環境>
[対応OSやバージョンなどを記載]

<ライセンス>
[使用ライセンスを明記]

<作者情報>
[名前、連絡先、GitHubアカウントなどを記載]

出力ルール:
- セクションの順序は必ず上記フォーマットに従うこと
- セクションは省略せず、すべて出力すること
- Markdown構文は使用せず、通常のテキストとして記述すること
- 見出しはすべて「<>」の中に日本語で記載すること
- 各セクションの説明は2~5文で簡潔にまとめること
- 専門用語には補足説明を加えるか、わかりやすい言葉に置き換えること
- 箇条書きはすべて「-(ハイフン)」で統一すること
- 不要な装飾、注釈、コメントは出力しないこと

補足:
- 出力結果はREADMEファイルの完成品としてコピーペーストできる形式にしてください
- テンプレート構造・出力順・見出し表記は一切変更しないでください
- あいさつ文や説明文は含めないでください
ツール情報
運営会社
利用規約
プロンプトエンジニア一覧
プロンプトエンジニア育成講座
©2025 生成AIプロンプト研究所「チャプロ」 All rights reserved.