README コンストラクター
プロジェクトとその読者に合った README を構築します。ユーザーをデザイナーとして扱います。プリセットは提案であり、構造、コンテンツ、ビジュアルは独立した選択肢です。プロジェクトの証拠とユーザーの既存の決定を使用します。機能、コマンド、結果、画像、主張を決して捏造しないでください。
発見と提案
レシピを提案する前に、関連するリポジトリ、既存のドキュメント、生成されたドキュメントのソース、およびアセットを検査します。READ ME の目的、対象読者、タイトル、トーン、およびレンダリングターゲットがデザインに影響を与える場合にそれらを特定します。要求された出力パスまたはチャットのみのドラフトを尊重します。出力が生成される場合は、ドキュメントソースを編集します。既存の README の場合は、有用な事実と既存のアセットを保持します。
以下のメニューを選択的に使用します。それらのパターンは、ユーザーが適応できる選択肢を提供します。リンクされた例は、Awesome README インデックス から選択された代表的なサブセットであり、簡潔なオリジナルノートで要約されています。スキルを使用するためにネットワークアクセスは必要ありません。
- 構造メニュー を使用して、順序付けられた開始点とセクションの選択肢を提案します。
- セクションコンテンツメニュー を使用して、選択された各セクションの形式、深さ、および証拠を選択します。
- ビジュアルメニュー を使用して、個々のビジュアル、配置、および利用可能または提案されたアセットを選択します。
新しい README または大規模なリデザインの場合は、提案された見出しの順序、各セクションのコンテンツの選択、および個別に配置されたビジュアルを示す、1つの調整可能なレシピを提示します。重要な場合にのみ、簡単なコンテキストの選択肢を含めます。コンパクトなメニューでは、ユーザーがセクションを追加、削除、名前変更、並べ替え、コンテンツを独立して選択し、個々のビジュアルを選択できるように、安定した ID を使用します。該当する場合は、none、keep、skip、recommend、および自由形式の選択肢を提供します。recommend は選択を委任することを説明します。ユーザーがプリセットとは独立してコンテンツとビジュアルを決定できるようにします。
ユーザーがすでに与えた選択肢を消費し、レシピを改訂するときにそれらを保持します。keep がリデザインで既存のアイテムを選択する場合、そのアイテムを保持して適用します。未解決のデザインの選択肢についてのみ、管理可能なメッセージにグループ化して尋ねます。新しい README または大幅に再設計された README のドラフトを作成する前に、それらの選択肢を待ちます。ただし、ユーザーが決定を委任した場合は除きます。ユーザーが十分な指示を与えた場合、またはユーザーがあなたに決定するよう依頼した場合は、適切なデフォルトで続行します。選択肢が解決されたら、再度承認を求めずに要求された成果物を作成します。狭い編集の場合は、新しいコンストラクターセッションを開始せずに、ユーザーのリクエストを直接実行します。
このコンパクトなやり取りをプロジェクトに適合させます。
提案された順序は
S1 概要 → S2 クイックスタート → S3 アーキテクチャです。コンテンツの選択肢はS1 問題 + スコープ、S2 最小限のコマンド、S3 プレーンテキストコンポーネントマップです。ビジュアルの選択肢はV1 S1 後のスクリーンショット（提案、利用可能なし）、V2 S3 後のアーキテクチャ図（提案）です。セクションと順序を選択し、任意のセクションのコンテンツを変更し、ビジュアルを個別に選択します。keepは特定の提案値を承諾し、noneはセクションまたはビジュアルを削除し、skipはオプションの選択肢を除外し、recommendはそれを委任します。カスタムテキストも歓迎します。ユーザーが選択
順序 S1, S3, S2 / S2 ガイド付き / V1 none / V2 keep / 残りは keep。
結果のレシピは S1 と S3 のコンテンツを保持し、S2 にはガイド付きクイックスタートを使用し、V1 を省略し、V2 を S3 の後に配置します。受け入れられた選択肢を再開することなく、残っている重要な不確実性を解決します。提案されたアセットと既存のアセットを区別します。提案されたアセットは、ユーザーが要求した範囲と利用可能なツール内でのみ作成または取得するか、省略してギャップを説明します。
作成と確認
選択されたレシピに従ってセクションを書き、プロジェクトからの具体的な内容をサポートします。可能な場合はコマンドを安全に検証します。未検証のコマンドや不足している情報にはラベルを付け、ドキュメントをテストするためだけに破壊的または副作用のあるコマンドを実行しないようにします。見出しの順序、リンク、アンカー、選択したプラットフォームの Markdown レンダリング、コードフェンスと言語タグ、および相対アセットパスを確認します。意味のある画像には有益な代替テキストを提供し、ビジュアルを使用する場合は明るいテーマと暗いテーマの両方で読みやすさを確認します。要求された範囲外の既存のコンテンツは保持します。結果とともに、重要なギャップと検証の制限を報告します。