Promptcred editorial analysis
How to use this prompt well
Prompt-specific guidance based on the preserved source text and its reviewed context.
Why Promptcred selected this prompt
The prompt ties a fixed WIKI.md structure to symbol, reference, type, call-hierarchy, and dependency inspection.
Best use cases
- Creating an initial architecture reference for a repository with working language tooling.
- Updating codebase documentation after major component or data-flow changes.
Required inputs
- Repository files, configuration entry points, and the language tooling available locally.
- The intended WIKI.md audience and any directories or generated code that should be excluded.
How to adapt it
- Replace the broad language list with the repository's actual language and LSP command.
- Reduce the required sections and diagrams to those supported by inspected symbols and dependencies.
Limitations and failure modes
- The fallback to AST or regex analysis can miss dynamic references and framework wiring.
- Requiring every Mermaid diagram can create speculative relationships when the code lacks the needed evidence.
Practical worked example
Editorial analysis reviewed Aug 23, 2026.
Promptcred-authored application and illustrative output. This is not a recorded model execution.
- Scenario
- Document a TypeScript service with an HTTP entry point, domain modules, and a database adapter.
- Inputs
- Provide the repository, tsconfig, package scripts, entry point, and exclusions for generated files.
- Promptcred-adapted instruction
- Use the TypeScript language server to trace the HTTP entry point to domain services and the database adapter. Generate only Project Overview, Architecture, Core Components, Data Flow, API Reference, and Development Guide. Mark regex-derived relationships as fallback evidence.
- Illustrative result
- Illustrative WIKI fragment: `POST /reports -> ReportController.create -> CreateReport.execute -> ReportRepository.save`. Evidence: symbol definition and call hierarchy. The database relationship diagram is omitted because the supplied code exposes no schema relationship evidence.
- Evaluation
- Every named component and dependency should resolve to code, and diagrams should agree with the documented call paths.
How to evaluate the output
- Symbols, APIs, and dependencies can be traced to repository files.
- The document marks fallback-derived relationships and does not present regex guesses as LSP facts.
Differences from related prompts
- Technical Writer: Codebase WIKI Documentation prescribes repository analysis and one WIKI.md inventory; Technical Writer supports narrower task-based documents as well.
Attributed community source material
Source 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`. Before use
Requirements and context
Repository / files
The repository or files within the task scope.
Language Server Protocol tooling
Inspect symbols, references, types, and call hierarchy as directed by the source.
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
- License
- CC0 1.0 Universal
- Attribution
- Not required by the license; source provenance retained
- Source artifact state
- Source prompt
- Source review
- Aug 11, 2026