Factory Agent - AI-gegenereerde codedocumentatie
Overzicht van codebeschrijving door Factory Agent
Factory Agent biedt AI-gegenereerde codedocumentatie direct binnen het SDA Platform, waardoor het voor engineeringteams eenvoudiger wordt om automatiseringsprojecten te begrijpen, te onderhouden en problemen erin op te lossen. Via de Project View analyseert Factory Agent automatisch de projectstructuur, logica, variabelen en code-artefacten om duidelijke, voor mensen leesbare documentatie te produceren.
Deze functionaliteit helpt teams om onboarding te versnellen, kennislacunes te verkleinen en de onderhoudbaarheid op lange termijn te verbeteren—vooral in omgevingen waar ongedocumenteerde kennis of verouderde codebases het onderhouden van handgeschreven documentatie bemoeilijken. Factory Agent-uitvoer wordt op verzoek gegenereerd, zodat de documentatie altijd de meest actuele versie van het project in SDA weergeeft.
Naast documentatie ondersteunt Factory Agent ook AI-ondersteunde codevergelijking voor dezelfde reeks ondersteunde leveranciers. Via de Compare Projects View stelt deze functie gebruikers in staat om twee versies van hetzelfde project te vergelijken en een duidelijke, gestructureerde samenvatting van de wijzigingen te ontvangen. De vergelijking van Factory Agent richt zich specifiek op wijzigingen tussen versies binnen een project en geeft zo diepgaander inzicht in aanpassingen, refactoring of onbedoelde bewerkingen. Hierdoor kunnen engineers wijzigingen snel valideren, begrijpen hoe die wijzigingen de functionele werking van het apparaat beïnvloeden, werk beoordelen vóór implementaties en auditklare inzichtelijkheid behouden in de manier waarop een project zich in de loop van de tijd ontwikkelt.
Compatibiliteitsmatrix van Factory Agent-leveranciers en PLC-talen
Software Defined Automation biedt een AI-gestuurde tool die gedetailleerde documentatie genereert voor elk project op bestandsniveau. Deze tool identificeert afhankelijkheden binnen het bestand en integreert deze naadloos in de documentatie.
Momenteel worden deze leveranciers en bestandsformaten ondersteund:
| Vendor | Structured Text / SCL | Ladder Logic | FBD |
|---|---|---|---|
| Beckhoff | true | true | false |
| BoschRexroth | true | true | false |
| CODESYS | true | true | true |
| Rockwell Automation | true | true | false |
| SEW MOVIRUN open | true | true | false |
| Siemens TIA Portal | true | true | false |
| WAGO | true | true | false |
Codedocumentatie genereren
Begin met het selecteren van het project waarvoor u documentatie wilt genereren in de hoofdprojectlijst. Klik op het gewenste project om de detailweergave en de beschikbare documentatieopties te openen.
Ondersteunde bestanden selecteren
Kies in de Project Viewer een bestand dat documentatiegeneratie ondersteunt.
Documentatiegeneratie starten
- Selecteer het gewenste bestand in de Project Viewer
- Klik op de knop "Explain" om het documentatiegeneratieproces te starten
- Er verschijnt een voortgangsbalk die de huidige status van het generatieproces weergeeft
Verwerking op de achtergrond: De documentatiegeneratie wordt als achtergrondproces uitgevoerd, waardoor u van de pagina weg kunt navigeren of uw browser kunt sluiten zonder de bewerking te onderbreken. U kunt later terugkomen om de voortgang te controleren of de voltooide documentatie te bekijken.
Opmerking: Alleen bestanden die aan de criteria voor ondersteunde formaten voldoen, zijn beschikbaar voor documentatiegeneratie. Raadpleeg het gedeelte Overzicht voor een volledige lijst van compatibele bestandstypen en -formaten.
Factory Agent voor codevergelijking (pre-release functie)
Begin met het selecteren van het project waarvoor u versieverschillen wilt vergelijken in de hoofdprojectlijst. Klik op het gewenste project om de detailweergave en de beschikbare documentatieopties te openen en selecteer 2 versies om te vergelijken. Selecteer vervolgens "Compare Versions" om de tool voor versievergelijking te openen.
Selecteer in de projectweergave een element dat verschillen toont. Doorgaans zijn die elementen blauw (gewijzigd), groen (toegevoegd) of rood (verwijderd) – wit betekent geen wijziging. Wanneer de vergelijkingsweergave wordt weergegeven, selecteert u "Explain" in het blok waarvan u een verklaring van het verschil wilt zien. De verklaring van het verschil wordt onder het blok weergegeven.
Detailniveaus van documentatie
Standaard genereert het systeem uitgebreide documentatie die een volledige analyse biedt met gedetailleerde uitleg en diepgaande dekking. Gebruikers kunnen echter overschakelen naar de samengevatte versie als zij een beknopter overzicht verkiezen.
- Uitgebreid: Biedt gedetailleerde uitleg, volledige analyse en diepgaande dekking (standaard)
- Samengevat: Geeft essentiële informatie en kernconcepten in een verkorte vorm