slogan3

Ontwikkel een AI-gestuurde Windsurf Codebase Documentatie Generator

description

Met deze prompt kun je een AI-gestuurde documentatiegenerator ontwikkelen die automatisch je codebase analyseert en heldere, gestructureerde documentatie maakt. Dit versnelt het documentatieproces, vermindert handmatig werk en verbetert de kennisoverdracht binnen je team, waardoor de samenwerking en onderhoudbaarheid van je project toenemen.

prompt

Help me een AI-gestuurde documentatiegenerator te ontwerpen binnen Windsurf die automatisch mijn codebase analyseert en begrijpelijke, gestructureerde documentatie produceert. Mijn softwareprojecttype: <voer het type s ...

try_prompt

generate_helper
disclaimerOnPageApi

ai_answers

provider: openai
model: gpt-4.1-nano
Natuurlijk! Hier is een voorstel voor het ontwerp van een AI-gestuurde documentatiegenerator binnen Windsurf, gericht op jouw webapplicatie voor e-commerce met JavaScript en Python: 1. **Analyseren van de codebase** - Gebruik AI-modellen om JavaScript- en Python-code te scannen op structuur en commentaar. - Detecteer en categoriseer API-endpoints (bijvoorbeeld REST, GraphQL). - Herken databasemodellen door ORM-definities of database schema’s te analyseren. 2. **Structureren van de documentatie** - Maak een hiërarchisch overzicht van API-endpoints, inclusief URL-patronen, HTTP-methoden, en functionaliteit. - Documenteer databasemodellen met velden, datatypes, relaties en constraints. - Voeg automatisch gegenereerde diagrammen toe voor datarelaties en API-architectuur. 3. **Gebruik van AI voor begrijpelijkheid** - Laat de AI samenvattingen genereren van complexe codeblokken en functionaliteiten. - Voeg inline opmerkingen en uitleg toe, gebaseerd op codecontext en commentaar. 4. **Automatisering en actualisering** - Implementeer een automatische updatefunctie die de documentatie bijwerkt bij codewijzigingen. - Bied een interactieve interface binnen Windsurf om door de documentatie te navigeren en details te bekijken. 5. **Configuratie en maatwerk** - Maak het mogelijk om te kiezen welke aspecten benadrukt worden (API, databasemodellen). - Laat gebruikers aangepaste sjablonen of templates toevoegen voor de documentatie. 6. **Technische implementatie** - Integreer AI-modellen zoals GPT-4 voor tekstgeneratie en code-analyse. - Gebruik parser-tools of statische analysetools (bijvoorbeeld ESLint, PyLint, Sequelize) voor structuurherkenning. - Bouw de generator als een Windsurf-plugin of module die automatisch draait bij code-commits of via een CLI. **Samenvattend:** Ontwerp een AI-gestuurde Windsurf-plugin die automatisch je JavaScript- en Python-code analyseert, API-endpoints en databasemodellen identificeert, en hiervan gestructureerde, begrijpelijke documentatie genereert. Focus op automatische updates, visuele representaties en gebruiksvriendelijke navigatie. Wil je dat ik een concreet stappenplan of voorbeeldcode voor de implementatie opstel?
provider: deepseek
model: deepseek-chat
Hier is een ontwerp voor een AI-gestuurde documentatiegenerator binnen Windsurf, speciaal afgestemd op jouw e-commerce webapplicatie: ## Architectuur Windsurf Documentatiegenerator ### 1. Codebase Analyse Module **Multi-language Parser** - JavaScript AST-analyse voor frontend/backend code - Python AST-analyse voor backend services - Database schema detectie (SQL/NoSQL) - API route detectie in beide talen ### 2. API Documentatie Generator **Automatische Endpoint Detectie** - RESTful routes analyse (Express.js, Flask/Django) - HTTP methoden (GET, POST, PUT, DELETE) - Request/Response schema extractie - Parameter validatie en types - Authenticatie requirements **API Specificaties** ```javascript // Voorbeeld output: { "endpoint": "/api/products", "method": "GET", "parameters": { "category": "string", "page": "number" }, "response": "Product[]", "authentication": "JWT required" } ``` ### 3. Database Model Documentatie **Model Analyse** - SQL schema parsing (MySQL/PostgreSQL) - MongoDB collection analyse - Relatie mapping tussen modellen - Data types en constraints - Indexen en optimalisaties **Model Documentatie Voorbeeld** ```python # Product Model - Tabellen: products, product_categories, inventory - Relaties: one-to-many met categories - Velden: id, name, price, description, category_id - Indexen: name (text), category_id (btree) ``` ### 4. E-commerce Specifieke Features **Domain-specifieke Documentatie** - Winkelwagen logica - Betalingsintegraties - Gebruikersprofielen en authenticatie - Bestelproces workflows - Inventory management flows ### 5. Documentatie Output Formaten **Multi-format Export** - OpenAPI/Swagger specificaties - Markdown voor ontwikkelaars - HTML voor webweergave - PDF voor offline gebruik - Interactive API playground ### 6. Integratie in Windsurf **Real-time Updates** - Automatische detectie van code wijzigingen - Incrementele documentatie updates - Version control integratie - Change tracking en history ### 7. AI-enhanced Features **Contextueel Begrip** - Natural language beschrijvingen van complexe flows - Code voorbeelden genereren - Best practices suggesties - Security considerations highlighting ### Implementatie Stappen 1. **Setup Phase** - Configureer codebase scanning - Definieer documentatie templates - Stel export preferences in 2. **Analysis Phase** - Automatische detectie van alle endpoints - Database model mapping - Relatie analyse tussen componenten 3. **Generation Phase** - Documentatie genereren in gekozen formaten - Cross-referencing tussen API en database - Validatie en quality checks 4. **Maintenance Phase** - Continue monitoring van wijzigingen - Automatische updates - Version management Deze generator zal volledig geïntegreerd zijn in jouw Windsurf workflow en real-time documentatie bijhouden terwijl je ontwikkelt aan je e-commerce applicatie.