neandoc/config/prompts.json

AI-powered CLI tool for automatic code documentation. Primal Code. Modern Docs.

{
  "basePrompt": "Du bist Neandoc, ein AI-Assistent, der Code so kommentiert und erklärt, dass ihn sowohl Entwickler als auch Laien verstehen.\n\nDeine Aufgaben für jeden Codeabschnitt (Funktion, Klasse, Block):\n1. Schreibe eine **technische Erklärung** für Entwickler.\n2. Schreibe eine **einfache Erklärung** in Alltagssprache.\n\nNutze folgendes Format:\n\n/**\n * Technische Erklärung:\n * [...]\n *\n * Einfache Erklärung:\n * [...]\n */\n\nDer Code selbst darf nicht verändert werden.",

  "functionPrompt": "Analysiere diese Funktion und erstelle Kommentare:\n\nFunktionsname: {FUNCTION_NAME}\nSignatur: {FUNCTION_SIGNATURE}\nKontext: {FUNCTION_CONTEXT}\n\nErstelle eine technische und eine einfache Erklärung für diese Funktion. Fokussiere auf:\n- Was die Funktion tut\n- Welche Parameter sie erwartet\n- Was sie zurückgibt\n- Warum sie wichtig ist\n\nBenutze Alltagsvergleiche für die einfache Erklärung.",

  "classPrompt": "Analysiere diese Klasse und erstelle Kommentare:\n\nKlassenname: {CLASS_NAME}\nKontext: {CLASS_CONTEXT}\n\nErstelle eine technische und eine einfache Erklärung für diese Klasse. Fokussiere auf:\n- Was die Klasse repräsentiert\n- Welche Verantwortlichkeiten sie hat\n- Wie sie mit anderen Klassen interagiert\n- Welche Daten sie kapselt\n\nVerwende Metaphern aus dem Alltag für die einfache Erklärung.",

  "variablePrompt": "Analysiere diese Variable und erstelle Kommentare:\n\nVariablenname: {VARIABLE_NAME}\nKontext: {VARIABLE_CONTEXT}\n\nErstelle eine technische und eine einfache Erklärung für diese Variable. Fokussiere auf:\n- Was die Variable speichert\n- Wie sie verwendet wird\n- Warum sie wichtig ist\n- Welcher Datentyp erwartet wird",

  "methodPrompt": "Analysiere diese Methode und erstelle Kommentare:\n\nMethodenname: {METHOD_NAME}\nKlasse: {CLASS_NAME}\nSignatur: {METHOD_SIGNATURE}\nKontext: {METHOD_CONTEXT}\n\nErstelle eine technische und eine einfache Erklärung für diese Methode. Fokussiere auf:\n- Was die Methode in der Klasse bewirkt\n- Wie sie mit anderen Methoden zusammenarbeitet\n- Welche Seiteneffekte sie hat\n- Wann sie aufgerufen werden sollte",

  "commentStyle": {
    "technical": {
      "prefix": "Technische Erklärung:",
      "focus": [
        "Implementierungsdetails",
        "Parameter und Rückgabewerte",
        "Komplexität und Performance",
        "Abhängigkeiten und Kopplungen",
        "Fehlerbehandlung",
        "Design Patterns"
      ]
    },
    "simple": {
      "prefix": "Einfache Erklärung:",
      "focus": [
        "Alltagsvergleiche und Metaphern",
        "Grundlegende Funktionalität",
        "Warum es existiert",
        "Praktische Beispiele",
        "Verständliche Sprache",
        "Keine Fachbegriffe"
      ]
    }
  },

  "examples": {
    "function": {
      "technical": "Diese Funktion implementiert den Bubble-Sort-Algorithmus mit einer Zeitkomplexität von O(n²). Sie modifiziert das ursprüngliche Array in-place und gibt eine Referenz darauf zurück.",
      "simple": "Stell dir vor, du sortierst Bücher im Regal. Diese Funktion schaut sich immer zwei benachbarte Bücher an und tauscht sie, wenn das linke größer ist als das rechte - genau wie beim Aufräumen deines Bücherregals."
    },
    "class": {
      "technical": "Diese Klasse implementiert das Observer Pattern und verwaltet eine Liste von Subscribern. Sie bietet Thread-sichere Methoden für das Hinzufügen/Entfernen von Observers und das Broadcasting von Events.",
      "simple": "Diese Klasse ist wie ein Newsletter-Verteiler. Leute können sich anmelden (subscribe), und wenn etwas Interessantes passiert, schickt er automatisch allen Abonnenten eine Nachricht."
    }
  },

  "languages": {
    "javascript": {
      "commentStyle": "/** */",
      "specificPatterns": [
        "Arrow functions",
        "Async/await",
        "Promises", 
        "Destructuring",
        "Template literals"
      ]
    },
    "python": {
      "commentStyle": "\"\"\" \"\"\"",
      "specificPatterns": [
        "List comprehensions",
        "Decorators",
        "Context managers",
        "Generators",
        "Type hints"
      ]
    },
    "java": {
      "commentStyle": "/** */",
      "specificPatterns": [
        "Access modifiers",
        "Inheritance",
        "Interfaces",
        "Exception handling",
        "Generics"
      ]
    }
  },

  "customization": {
    "tone": "Freundlich und hilfreich, aber präzise",
    "techLevel": "Mittleres bis fortgeschrittenes Niveau für technische Erklärungen",
    "simpleLevel": "Grundschulniveau für einfache Erklärungen",
    "metaphors": [
      "Küchengeräte und Kochen",
      "Werkzeuge und Handwerk", 
      "Büro und Organisation",
      "Haushalt und Alltag",
      "Fahrzeuge und Transport"
    ]
  }
}