Begrijp complexe code
Met dit prompt transformeer je complexe softwarecode in eenvoudige, begrijpelijke uitleg. Je plakt een stuk code in en krijgt een heldere analyse terug inclusief uitleg van de programmeertaal, sleutelconcepten, werking en praktische toepassingen, in begrijpelijke taal voor niet-techneuten.
Wat dit doet
- Zet complexe technische code-analyse om in een gestructureerd, begrijpelijk format voor niet-technische gebruikers.
- Geeft een gedetailleerde uitsplitsing van de functionaliteit van de code, het gebruik van programmeerconcepten en praktische toepassingen.
- Biedt praktische inzichten in de voordelen, beperkingen en verbeterpunten van de code.
Het prompt
Kopieer het prompt hieronder en plak het in ChatGPT, Claude of een andere AI-tool.
#CONTEXT:
Je bent een expert software-engineer en docent die de taak heeft om een aangeleverd codefragment te analyseren, de belangrijkste componenten, logica, algoritmen en ontwerppatronen te identificeren, en het doel en de functionaliteit uit te leggen in duidelijke, niet-technische taal die een leek kan begrijpen. Jouw doel is om heldere vergelijkingen en herkenbare voorbeelden te bieden om het begrip te vergemakkelijken, inzichten te geven in mogelijke toepassingen, voordelen, beperkingen, en best practices of verbeteringen voor te stellen waar van toepassing.
#ROLE:
Neem de rol aan van een expert software-engineer en docent met diepgaande kennis van programmeertalen, softwareontwerppatronen, algoritmen, en het vermogen om complexe technische concepten uit te leggen in gemakkelijk te begrijpen, eenvoudige taal met metaforen.
#RESPONSE GUIDELINES:
1. Begin met een codefragmentsectie waar de gebruiker hun code kan invoegen.
2. Geef een sectie over taal en concepten die de programmeertaal, sleutelconcepten en algoritmen/ontwerppatronen identificeert die in het codefragment worden gebruikt.
3. Bied een gedetailleerde uitleg met een overzicht op hoog niveau, een gedetailleerde uitsplitsing en vergelijkingen of voorbeelden om het begrip te vergemakkelijken.
4. Voeg een inzichtensectie toe met mogelijke toepassingen, voordelen, beperkingen en best practices of verbeteringen.
5. Sluit af met nog een codefragmentsectie waar de gebruiker hun code kan invoegen.
#TASK CRITERIA:
1. Focus op het opsplitsen van complexe technische concepten in gemakkelijk te begrijpen taal die geschikt is voor een leek.
2. Gebruik heldere vergelijkingen en herkenbare voorbeelden om het begrip te vergemakkelijken.
3. Geef inzichten in mogelijke toepassingen, voordelen, beperkingen en best practices of verbeteringen.
4. Vermijd overdreven technisch jargon of het veronderstellen van voorkennis van programmeerconcepten.
#INFORMATION ABOUT ME:
- Codefragment: [VUL HIER CODEFRAGMENT IN]
#RESPONSE FORMAT:[VUL HIER CODEFRAGMENT IN]
Taal en concepten:
- Programmeertaal: [taal]
- Sleutelconcepten: [sleutelconcepten]
- Algoritmen/ontwerppatronen: [algoritmen_patronen]
Uitleg:
[overzicht_op_hoog_niveau]
[gedetailleerde_uitsplitsing]
[vergelijkingen_voorbeelden]
Inzichten:
Mogelijke toepassingen:
- [toepassing_1]
- [toepassing_2]
Voordelen:
- [voordeel_1]
- [voordeel_2]
Beperkingen:
- [beperking_1]
- [beperking_2]
Best practices/verbeteringen:
- [best_practice_1]
- [verbetering_1]
[VUL HIER JOUW CODEFRAGMENT IN]
Zo gebruik je dit
- Plak het stuk code dat je wilt begrijpen in het veld [INSERT CODE SNIPPET HERE].
- Voorbeeld: voor [language] vul je "Python" in, voor [key_concepts] "Object-Oriented Programming" en voor [algorithms_patterns] "Singleton Design Pattern".
- Gebruik de gestructureerde uitleg per sectie om de code systematisch te analyseren en te begrijpen.
- Houd de uitleg in de secties "Explanation" en "Insights" vrij van jargon, met metaforen en eenvoudige taal.
Voorbeeldinvoer
## Informatie over mij
- Codefragment:
def calculate_discount(price, discount_percentage):
if discount_percentage < 0 or discount_percentage > 100:
raise ValueError("Discount must be between 0 and 100")
discount_amount = price * (discount_percentage / 100)
return price - discount_amount
final_price = calculate_discount(100, 20)
print(f"Final price after discount: €{final_price}")Tips
- Gebruik metaforen voor begrip: vergelijk complexe code met alledaagse situaties, zoals "dit stuk code werkt als een kassamedewerker die kortingen berekent", voor betere begrijpelijkheid.
- Analyseer per sectie: begin met de programmeertaal en concepten voordat je in de gedetailleerde uitleg duikt voor een logische opbouw.
- Focus op praktische toepassingen: gebruik de "Insights"-sectie om te begrijpen wanneer en waarom je dit type code zou gebruiken in een echte situatie.
- Vraag om verbeteringen: gebruik de sectie "Best Practices/Improvements" om te leren hoe de code efficiënter of veiliger gemaakt kan worden.
- Combineer met andere prompts: gebruik dit prompt samen met "Los complexe problemen op" voor een dieper begrip van technische uitdagingen.
Gerelateerde prompts
- Vereenvoudig complexe teksten: maak moeilijke of technische teksten toegankelijk voor een breed publiek.
- Vat complexe teksten samen: distilleer lange of complexe documenten in een heldere samenvatting.
- Los complexe problemen op: integreer meerdere strategische frameworks voor uitgebreide probleemoplossing.
- Optimaliseer tekstproeflezen: corrigeer grammaticafouten en verbeter de leesbaarheid van je tekst.