Broklam/readme-constructor

README-Konstruktor

Erstelle eine README, die zum Projekt und seinen Lesern passt. Behandle den Benutzer als Designer. Voreinstellungen sind Vorschläge, und Struktur, Inhalt sowie visuelle Elemente sind unabhängige Entscheidungen. Nutze Projektevidenz und die bereits getroffenen Entscheidungen des Benutzers. Erfinde niemals Funktionen, Befehle, Ergebnisse, Bilder oder Behauptungen.

Entdecken und vorschlagen

Überprüfe das relevante Repository, die vorhandene Dokumentation, die Quelle der generierten Dokumentation und Assets, bevor du einen Bauplan vorschlägst. Identifiziere den Zweck der README, die Zielgruppe, den Titel, den Ton und das Rendering-Ziel, wenn diese das Design beeinflussen. Respektiere einen angeforderten Ausgabepfad oder einen Chat-Only-Entwurf. Bearbeite die Dokumentationsquelle, wenn die Ausgabe generiert wird. Bewahre nützliche Fakten und vorhandene Assets, insbesondere bei einer bestehenden README.

Verwende die folgenden Menüs selektiv. Ihre Muster bieten dem Benutzer Anpassungsmöglichkeiten. Die verlinkten Beispiele sind eine repräsentative Auswahl aus dem Awesome README Index, zusammengefasst in kurzen Originalnotizen. Für die Nutzung des Skills ist kein Netzwerkzugriff erforderlich.

• Verwende das Strukturmenü, um einen geordneten Ausgangspunkt und Abschnittsentscheidungen vorzuschlagen.
• Verwende das Inhaltsmenü für Abschnitte, um Format, Tiefe und Evidenz für jeden ausgewählten Abschnitt zu wählen.
• Verwende das Visuelle-Menü, um einzelne visuelle Elemente, deren Platzierung und verfügbare oder vorgeschlagene Assets auszuwählen.

Präsentiere für eine neue README oder ein großes Redesign einen maßgeschneiderten, bearbeitbaren Bauplan, der die vorgeschlagene Überschriftenreihenfolge, eine Inhaltsauswahl für jeden Abschnitt und alle individuell platzierten visuellen Elemente zeigt. Füge kurze Kontextentscheidungen nur dort ein, wo sie wesentlich bleiben. Verwende in einem kompakten Menü stabile IDs, sodass der Benutzer Abschnitte hinzufügen, entfernen, umbenennen oder neu anordnen, deren Inhalte unabhängig wählen und einzelne visuelle Elemente aktivieren kann. Biete none, keep, skip, recommend und Freitextentscheidungen an, wo angebracht. Erkläre, dass recommend die Entscheidung delegiert. Lass den Benutzer Inhalt und visuelle Elemente unabhängig von einer Voreinstellung wählen.

Verarbeite bereits vom Benutzer getroffene Entscheidungen und behalte sie bei, wenn du den Bauplan überarbeitest. Wenn keep ein vorhandenes Element in einem Redesign auswählt, bewahre und wende dieses Element an. Frage nur nach ungelösten Designentscheidungen, gruppiert in einer überschaubaren Nachricht. Warte auf diese Entscheidungen, bevor du eine neue oder grundlegend überarbeitete README entwirfst, es sei denn, der Benutzer hat die Entscheidungen delegiert. Wenn der Benutzer ausreichende Anweisungen gegeben oder dich gebeten hat, zu entscheiden, fahre mit geeigneten Standardeinstellungen fort. Sobald die Entscheidungen getroffen sind, erstelle das angeforderte Ergebnis ohne weitere Genehmigung. Für gezielte Bearbeitungen führe die Anfrage des Benutzers direkt aus, ohne eine neue Konstruktorsitzung zu starten.

Passe diesen kompakten Austausch an das Projekt an.

Vorgeschlagene Reihenfolge ist S1 Übersicht → S2 Schnellstart → S3 Architektur. Inhaltsentscheidungen sind S1 Problem + Umfang, S2 minimale Befehle und S3 Klartext-Komponentenkarte. Visuelle Entscheidungen sind V1 Screenshot nach S1 (vorgeschlagen, nicht verfügbar) und V2 Architekturdiagramm nach S3 (vorgeschlagen). Wähle Abschnitte und Reihenfolge, ändere den Inhalt jedes Abschnitts und wähle visuelle Elemente einzeln aus. keep akzeptiert den spezifischen vorgeschlagenen Wert, none entfernt einen Abschnitt oder ein visuelles Element, skip lässt eine optionale Entscheidung aus, und recommend delegiert sie. Eigener Text ist willkommen.

Benutzer wählt Reihenfolge S1, S3, S2 / S2 geführt / V1 none / V2 keep / Rest keep.

Das resultierende Rezept behält die Inhalte von S1 und S3, verwendet einen geführten Schnellstart für S2, lässt V1 weg und platziert V2 nach S3. Löse alle verbleibenden wesentlichen Unsicherheiten, ohne bereits akzeptierte Entscheidungen erneut zu öffnen. Unterscheide vorgeschlagene Assets von vorhandenen Assets. Erstelle oder besorge ein vorgeschlagenes Asset nur innerhalb des vom Benutzer angeforderten Rahmens und der verfügbaren Werkzeuge, oder lasse es weg und erkläre die Lücke.

Erstellen und überprüfen

Schreibe Abschnitte gemäß dem gewählten Bauplan und unterstütze Spezifika aus dem Projekt. Überprüfe Befehle sicher, wo praktikabel. Kennzeichne ungeprüfte Befehle oder fehlende Informationen und vermeide die Ausführung von zerstörerischen oder nebenwirkungsbehafteten Befehlen nur zum Testen der Dokumentation. Überprüfe die Überschriftenreihenfolge und Links, Anker, Markdown-Rendering für die gewählte Plattform, Codeblöcke und Sprach-Tags sowie relative Asset-Pfade. Gib informativen Alternativtext für bedeutungsvolle Bilder und überprüfe die Lesbarkeit in hellen und dunklen Themen, wenn visuelle Elemente verwendet werden. Bewahre vorhandene Inhalte außerhalb des angeforderten Rahmens. Melde wesentliche Lücken und Einschränkungen der Überprüfung zusammen mit dem Ergebnis.