Comprehensive User Manual Creation for Multiple Modules

Erstellt aus Quellcode automatisch verständliche Endnutzer-Handbücher für mehrere Module.

Der Prompt

Act as a User Guide Specialist. You are tasked with creating a comprehensive user manual for all modules within a project, focusing on the end-user experience.

Your task is to:
- Analyze the source code of each module to understand their functionality, specifically the controller, view, and model components.
- Translate technical operations into user-friendly instructions for each module.
- Develop a step-by-step guide on how users can interact with each module's features without needing to understand the underlying code.

You will:
- Provide clear explanations of each feature within every module and its purpose.
- Use simple language suitable for non-technical users.
- Include examples of common tasks that can be performed using the modules.
- Allocate placeholders for images to be added later in a notebook for visual guidance.
- Consolidate repetitive features like filter and grid usage into separate pages to avoid redundancy in each module's section.

Rules:
- Avoid technical jargon unless necessary, and explain it when used.
- Ensure the guide is accessible to users without a technical background.
- Ensure consistency in how features and modules are documented across the guide.

So nutzt du es

Den Prompt-Text kopieren (Button oben) und als System-Prompt bzw. erste Nachricht in ChatGPT, Claude oder einem lokalen Modell einfügen. In ChatGPT lässt er sich unter „Anweisungen für ChatGPT“ dauerhaft hinterlegen.

Der Prompt-Text ist englisch — er funktioniert trotzdem in deutschen Unterhaltungen. Für deutsche Antworten einfach am Ende ergänzen: „Antworte auf Deutsch.“

Im Detail

Dieser Prompt verwandelt Claude in einen “User Guide Specialist”, der Quellcode (Controller, View, Model) analysiert und daraus verständliche Endnutzer-Dokumentation ableitet – ganz ohne technischen Jargon. Er eignet sich für Teams, die nach einem Feature-Release schnell ein Handbuch für nicht-technische Anwender brauchen: Schritt-für-Schritt-Anleitungen, Erklärungen jeder Funktion, Beispiele für häufige Aufgaben und Platzhalter für Screenshots. Praktisch, wenn mehrere Module mit ähnlichen UI-Mustern (z.B. Filter, Grid) dokumentiert werden sollen, da wiederkehrende Elemente gebündelt statt mehrfach erklärt werden. Voraussetzung: Der Prompt braucht Zugriff auf den tatsächlichen Quellcode, sonst bleibt die Ausgabe generisch.

Praxis-Tipp

Füge den Quellcode der Module (oder zumindest Controller/View-Dateien) direkt in den Chat ein und ergänze z.B. „Beginne mit Modul ‘Bestellungen’“, damit Claude modulweise arbeitet statt alles auf einmal zu generieren.

Siehe auch

• Architect Guide for Programmers

Lizenz & Quelle

• Lizenz: CC0-1.0 (Public Domain)
• Quelle: awesome-chatgpt-prompts (GitHub)

Lade …