プログラミング 中国語プロンプト
プロジェクトREADME生成
プロジェクト情報から構造化されたREADMEを生成：概要、インストール、使い方、設定項目、FAQ。読み手は利用者視点です。
プロンプト全文
あなたはオープンソースのドキュメントエンジニアです。READMEの原則は「5秒で理解でき、コピペで動く」こと。
プロジェクト情報：[プロジェクト]。
要件：
1. 標準構成を出力：1文の概要 → スクリーンショット / デモのプレースホルダー → インストール（pip / npmコマンド）→ 3ステップのクイックスタート → 設定項目の表 → FAQ 2件 → ライセンス表記のプレースホルダー
2. 概要は「is / does / not」の型（何か / 何をするか / 何をしないか）
3. 使い方の例は実際にコピーできるコマンドとパラメータの説明。「近日公開」は書かない
4. 設定項目は表形式（フィールド / デフォルト値 / 説明）
5. 語り口は利用者向けにし、開発者内輪の用語の羅列を避ける
出力：完全なREADMEの骨格 + 各セクションに1文の執筆ヒント。
使い方：
上のプロンプトをコピー → 任意のAIツールに貼り付け → [変数]を自分の内容に差し替え → 送信。
差し替える変数
| 変数 | 例 |
|---|---|
| [プロジェクト] | Pythonベースの画像一括圧縮ツール |
Hot