Websites
Prompt für eine Produktdokumentation
Baue eine durchsuchbare Dokumentation mit Schnellstart, Referenz und Versionshinweisen.
Redaktionelle Prüfung · Vibe Coding ·
Wann passt dieser Prompt?
Für Produkte und Open-Source-Projekte mit geprüften Anleitungen und Versionsinformationen.
Kopierbare Bauanweisung
Erstelle öffentliche Dokumentation für [PRODUCT] und [READERS]. Die erste Aufgabe ist [FIRST TASK]. Nutze Projektquellen und markiere Beispiele und ungeprüfte Befehle. Funktionen und Umsetzung: 1. Gliedere in Schnellstart, Anleitungen, Referenz, Fehlerbehebung und Änderungsprotokoll. Beschreibe Voraussetzungen, Ergebnis und nächste Schritte. 2. Vergib stabile URLs, Titel, Inhaltsverzeichnisse und Breadcrumbs. Verlinke öffentliche Artikel im Index und ermögliche mobile und Tastaturnavigation. 3. Durchsuche Titel, Text und Fehlermeldungen. Zeige den Fundort und einen leeren Zustand. Entwürfe bleiben aus Suche, Sitemap und Gastzugriff. 4. Zeige gültige Versionen an relevanten Stellen, leite verschobene URLs um und kennzeichne Altversionen. Kopierbare Beispiele enthalten keine Zugangsdaten. 5. Ergänze Bearbeitungs- oder Feedbacklinks und Quellen. Liefere Schnellstart, Fehlerbehebung und Änderungsnotiz und prüfe alles in einer leeren Umgebung. Zeige plattformspezifische Befehle nur nach Prüfung. Kontrolliere Überschriften, Codeblöcke und Direktlinks im Build. Öffne Suchtreffer per Tastatur. Projektdaten ersetzen: [PRODUCT], [READERS], [FIRST TASK]. Arbeite mobilfreundlich, semantisch und mit sichtbarem Tastaturfokus. Verwende echte Inhalte oder klar gekennzeichnete Beispieldaten. Baue Lade-, Leer-, Fehler- und Erfolgszustände für die wichtigen Abläufe. Behaupte keine fertige Integration, wenn nur eine Oberfläche existiert. Dokumentiere offene Voraussetzungen und teste den Hauptablauf vor der Übergabe. Abnahmekriterien: - Der Schnellstart funktioniert in einer frischen Umgebung. - Die Suche findet Fehlertexte und keine Entwürfe. - Ein alter Link leitet zu einem Artikel mit Versionsangabe.
Vollständige englische Referenz ansehen
Build public documentation for [PRODUCT] serving [READERS]. The most important first success is [FIRST TASK]. Use only source material supplied by the project. Mark sample values and flag unverified commands instead of inventing features.
1. Separate a quick start, task guides, reference, troubleshooting, and changelog. Each guide states prerequisites, expected results, and the next step. Show platform-specific commands only when verified.
2. Give each article a stable slug, visible page title, local table of contents, and breadcrumbs. Maintain a docs index with links to every public section. On narrow screens, make the navigation and search usable by touch and keyboard.
3. Search titles, body text, and error phrases. Show where each result comes from and handle no results. Exclude unpublished pages from search, sitemap, and anonymous access.
4. Put the current version and supported versions near affected instructions. Maintain redirects for moved pages and warn on archived versions. Copyable code must exclude shell prompts and use placeholders instead of credentials.
5. Include an edit or feedback link and a source for factual claims. Check the quick start from an empty project and verify all links, headings, and code blocks in the built output.
Deliver a sample quick start, a troubleshooting article, and a changelog entry. Verify direct URLs, keyboard search, and an old link that redirects to its replacement.Anleitung
Passendes Ergebnis wählen
Wähle eine Vorlage für den benötigten Seitentyp und Nutzerablauf.
Variablen ersetzen
Ergänze Zielgruppe, Ziel, Inhalte, Gestaltung und technische Vorgaben.
Vor dem Absenden bearbeiten
Streiche unnötige Funktionen und kläre widersprüchliche Anforderungen.
Testen und nachbessern
Prüfe Mobilansicht, Barrierefreiheit, Interaktionen, Daten und Randfälle.
Erwartetes Ergebnis
Eine durchsuchbare und indexierbare Dokumentationsseite mit überprüftem Einstieg.
Warum diese Struktur funktioniert
- Gliedert Anleitungen nach Leseraufgaben
- Verankert dauerhafte Navigation und Quellen
- Prüft Schnellstart und Weiterleitungen praktisch
Abnahmekriterien
- Der Schnellstart funktioniert in einer frischen Umgebung.
- Die Suche findet Fehlertexte und keine Entwürfe.
- Ein alter Link leitet zu einem Artikel mit Versionsangabe.
Projektdaten ersetzen
[PRODUCT]- Entwickler, die ein CLI einbinden
[READERS]- Open-Source-Tool für Bildskalierung
[FIRST TASK]- Ein Bild skalieren und die Ausgabe finden
Quellen und Prüfbasis
Die Quellen erklären Methoden und technische Anforderungen. Der Prompt wurde eigenständig formuliert.