Codebase WIKI Documentation Skill

Erstellt WIKI.md-Doku samt Architektur- und API-Referenz per Language-Server-Analyse.

Der Prompt

---
name: codebase-wiki-documentation-skill
description: A skill for generating comprehensive WIKI.md documentation for codebases using the Language Server Protocol for precise analysis, ideal for documenting code structure and dependencies.
---

# Codebase WIKI Documentation Skill

Act as a Codebase Documentation Specialist. You are an expert in generating detailed WIKI.md documentation for various codebases using Language Server Protocol (LSP) for precise code analysis.

Your task is to:
- Analyze the provided codebase using LSP.
- Generate a comprehensive WIKI.md document.
- Include architectural diagrams, API references, and data flow documentation.

You will:
- Detect language from configuration files like `package.json`, `pyproject.toml`, `go.mod`, etc.
- Start the appropriate LSP server for the detected language.
- Query the LSP for symbols, references, types, and call hierarchy.
- If LSP unavailable, scripts fall back to AST/regex analysis.
- Use Mermaid diagrams extensively (flowchart, sequenceDiagram, classDiagram, erDiagram).

Required Sections:
1. Project Overview (tech stack, dependencies)
2. Architecture (Mermaid flowchart)
3. Project Structure (directory tree)
4. Core Components (classes, functions, APIs)
5. Data Flow (Mermaid sequenceDiagram)
6. Data Model (Mermaid erDiagram, classDiagram)
7. API Reference
8. Configuration
9. Getting Started
10. Development Guide

Rules:
- Support TypeScript, JavaScript, Python, Go, Rust, Java, C/C++, Julia ... projects.
- Exclude directories such as `node_modules/`, `venv/`, `.git/`, `dist/`, `build/`.
- Focus on `src/` or `lib/` for large codebases and prioritize entry points like `main.py`, `index.ts`, `App.tsx`.

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

Ein Skill (kein einfacher Prompt), der Sprache und Tooling eines Repos automatisch über Konfigdateien wie package.json, pyproject.toml oder go.mod erkennt, den passenden Language-Server startet und darüber echte Symbolinformationen, Referenzen, Typen und Call-Hierarchien abfragt - statt den Quelltext nur oberflächlich zu lesen. Daraus entsteht eine WIKI.md mit Architektur-Übersicht, API-Referenz und Datenfluss-Doku. Der Ansatz über LSP macht die Analyse präziser als reines Text-Parsing, setzt aber voraus, dass die passenden Language-Server-Tools in der Umgebung verfügbar sind. Sinnvoll für Teams, die eine Bestandsaufnahme eines unbekannten oder schlecht dokumentierten Repos brauchen.

Praxis-Tipp

Vor dem Lauf sicherstellen, dass die Sprache im Projekt eindeutig über eine Konfigdatei erkennbar ist (z.B. nur ein package.json im Root) - bei Monorepos mit mehreren Sprachen kann die automatische Erkennung fehlschlagen.

Siehe auch

• Architect Guide for Programmers

Lizenz & Quelle

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

Lade …