💻 Programmierung & Entwicklung

Comprehensive User Manual Creation for Multiple Modules

📁 Programmierung & Entwicklung 👤 Beigetragen von @eegesengul 🗓️ Aktualisiert
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 diesen Prompt

Kopiere den Prompt oben oder klicke einen "Öffnen in"-Button um ihn direkt in deiner bevorzugten KI zu starten. Du kannst den Text dann an deinen Anwendungsfall anpassen — z.B. Platzhalter wie [dein Thema] durch echten Kontext ersetzen.

Welches KI-Modell funktioniert am besten

Claude Opus 4 und Sonnet 4.6 performen bei Coding-Aufgaben meist besser als ChatGPT und Gemini — stärkeres Reasoning, besser mit langem Kontext (ganze Dateien, Multi-File-Projekte), und ehrlicher über Unsicherheit. ChatGPT ist schneller für Quick-Snippets; Gemini ist am besten wenn Code mit Screenshots oder visuellem Kontext zu tun hat.

Diesen Prompt anpassen

Tausche die im Prompt erwähnte Sprache (Python, JavaScript, etc.) gegen deinen Stack. Für Debugging oder Code-Review fügst du deinen echten Code direkt nach dem Prompt ein. Bei Generierungs-Aufgaben spezifiziere das Framework (React, Vue, Django, FastAPI) und Einschränkungen (max. Zeilen, keine externen Libraries, muss async sein).

Typische Anwendungsfälle

  • Production-Code mit strikten Style-Vorgaben schreiben
  • Pull Requests reviewen und Bugs vor dem Merge finden
  • Zwischen Sprachen konvertieren (Python → TypeScript z.B.)
  • Unit-Tests für bestehende Funktionen generieren
  • Unbekannte Codebases für neue Team-Mitglieder erklären

Variationen

Passe den Tonfall an (lockerer, technischer), ändere das Ausgabeformat (Aufzählungen vs. Absätze) oder füge Einschränkungen hinzu (Wortlimits, Zielgruppe).

Verwandte Prompts