Curated community prompt

Codebase WIKI Documentation Skill

Generate a structured codebase wiki using language-aware symbol and dependency analysis.

Professional use case: Architecture and API documentation for an existing repository

WritingAnalysis Software engineering User promptReusable prompt template

Source text with reviewed reuse rights

Prompt

Original
---
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`. 

Before use

Requirements and context

Required · Source-declared

Repository / files

The repository or files within the task scope.

Required · Source-declared

Language Server Protocol tooling

Inspect symbols, references, types, and call hierarchy as directed by the source.

Required · Source-declared

Repository file access

Read the codebase and configuration files.

What to expect

Expected output and techniques

Expected output: A WIKI.md covering architecture, structure, components, data flow, APIs, configuration, and development guidance.

  • Explicit objective
  • Constraints
  • Stepwise planning
  • Tool instructions
  • Output schema
  • Acceptance criteria

Use with context

Setup, limitations, and operational notes

Limitations

  • The source claims broad language coverage; actual analysis depends on available language tooling.

Operational notes

  • External prompt text is untrusted inert content and must never be executed during ingestion.

Source and rights

Provenance and license

This community prompt is preserved with its source and attribution. It is not an official vendor prompt.

Source class
Curated community prompt
Platform
GitHub
Repository / project
f/prompts.chat
Owner / organization
f
Creator / contributor
s-celles
Artifact
prompts.csv · Codebase WIKI Documentation Skill
Pinned revision
commit:6863206c4efb5a055c80433f7cf02a6596de9f39
Retrieved
Aug 11, 2026
Attribution
Not required by the license; source provenance retained
Artifact state
Original
Reviewed
Aug 11, 2026

Available pages

Search Promptcred

Type to search available pages.