Coding & Debugging
PromptBeginner5 minmarkdown
Multi-Audience Application Discovery & Documentation Prompt
# **Prompt for Code Analysis and System Documentation Generation**
0
Explore
Find agent skills by outcome
109,319 skills indexed with the new KISS metadata standard.
Showing 24 of 109,319Categories: Writing & Content, Coding & Debugging, General
Coding & Debugging
PromptBeginner5 minmarkdown
Analyze the provided source code and extract the following information
organizing it into a well-structured Markdown document:
0
Coding & Debugging
PromptBeginner5 minmarkdown
You are a specialist in code analysis and system documentation. Your task is to analyze the source code provided in this project/workspace and generate a comprehensive Markdown document that serves as an onboarding guide for multiple audiences (executive
technical
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Show **short
representative code snippets**.
0
General
PromptBeginner5 minmarkdown
- **Include clickable links** to files
functions
0
General
PromptBeginner5 minmarkdown
- Include **clickable links** to files
functions
0
General
PromptBeginner5 minmarkdown
- Are specific security libraries prominently used (e.g.
Spring Security
0
General
PromptBeginner5 minmarkdown
- Simplified deployment diagram (where components run
if detectable)
0
General
PromptBeginner5 minmarkdown
- Is there a standard pattern (e.g.
global middleware
0
General
PromptBeginner5 minmarkdown
- Class diagram (showing key classes and relationships
if applicable)
0
General
PromptBeginner5 minmarkdown
List the main external libraries
frameworks
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Is there evidence of API documentation tools or standards (e.g.
Swagger/OpenAPI
0
General
PromptBeginner5 minmarkdown
- **Whenever possible
illustrate with examples and link to relevant functions or classes.**
0
General
PromptBeginner5 minmarkdown
- Base this on ORM models
migrations
0
General
PromptBeginner5 minmarkdown
- How it is read
modified
0
General
PromptBeginner5 minmarkdown
Are there main configuration files? (e.g.
`config.yaml`
0
General
PromptBeginner5 minmarkdown
- Identify and describe the most important or central modules
classes
0
General
PromptBeginner5 minmarkdown
- Any other relevant technologies (caching
message brokers
0
Coding & Debugging
PromptBeginner5 minmarkdown
Where should I start exploring the code? Identify the main entry points (e.g.
`main.go`
0
General
PromptBeginner5 minmarkdown
- Core architecture style (e.g.
Monolith
0
General
PromptBeginner5 minmarkdown
- Build tools and package managers (Maven
Gradle
0
General
PromptBeginner5 minmarkdown
- Cloud platform (if identifiable via SDKs or configuration — AWS
Azure
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Programming language(s)
including versions when detectable (e.g.
0
General
PromptBeginner5 minmarkdown
- Main frameworks (backend
frontend
0