Hoppa till huvudinnehåll

Factory Agent – AI-genererad koddokumentation

Översikt över kodbeskrivning i Factory Agent​

Factory Agent tillhandahåller AI-genererad koddokumentation direkt i SDA-plattformen, vilket gör det enklare för ingenjörsteam att förstå, underhålla och felsöka automationsprojekt. Via Project View analyserar Factory Agent automatiskt projektstruktur, logik, variabler och kodartefakter för att skapa tydlig, lättläst dokumentation.

Denna funktion hjälper team att snabba upp introduktionen av nya medarbetare, minska kunskapsluckor och förbättra långsiktig underhållbarhet – särskilt i miljöer där informell kunskap eller äldre kodbaser gör handskriven dokumentation svår att underhålla. Factory Agents utdata genereras vid behov, vilket säkerställer att dokumentationen återspeglar den senaste versionen av projektet som lagras i SDA.

Utöver dokumentation stöder Factory Agent även AI-assisterad kodjämförelse för samma uppsättning stödda tillverkare. Via Compare Projects View kan användare med denna funktion jämföra två versioner av samma projekt och få en tydlig, strukturerad sammanfattning av vad som har ändrats. Factory Agents jämförelse fokuserar specifikt på förändringar mellan versioner inom ett projekt och ger djupare insikt i ändringar, refaktorisering eller oavsiktliga redigeringar. Detta gör att ingenjörer snabbt kan validera ändringar, förstå hur dessa ändringar påverkar enhetens funktionella drift, granska arbete före driftsättning och upprätthålla revisionsklar insyn i hur ett projekt utvecklas över tid.

Kompatibilitetsmatris för Factory Agent-tillverkare och PLC-språk​

Software Defined Automation tillhandahåller ett AI-drivet verktyg som genererar detaljerad dokumentation för varje projekt på filnivå. Verktyget identifierar beroenden i filen och integrerar dem sömlöst i dokumentationen.

För närvarande stöds dessa tillverkare och filformat:

VendorStructured Text / SCLLadder LogicFBD
Beckhofftruetruefalse
BoschRexrothtruetruefalse
CODESYStruetruetrue
Rockwell Automationtruetruefalse
SEW MOVIRUN opentruetruefalse
Siemens TIA Portaltruetruefalse
WAGOtruetruefalse

Så genererar du koddokumentation​

Börja med att välja det projekt som du vill generera dokumentation för i huvudprojektlistan. Klicka på önskat projekt för att öppna dess detaljvy och tillgängliga dokumentationsalternativ.

Välja filer som stöds

Välj i Project Viewer valfri fil som stöder generering av dokumentation.

Starta dokumentationsgenerering

  1. Välj önskad fil i Project Viewer
  2. Klicka på knappen "Explain" för att starta processen för dokumentationsgenerering
  3. En förloppsindikator visas med aktuell status för genereringsprocessen

Bakgrundsbearbetning: Dokumentationsgenereringen körs som en bakgrundsprocess, vilket gör att du kan navigera bort från sidan eller stänga webbläsaren utan att avbryta åtgärden. Du kan återvända senare för att kontrollera förloppet eller visa den färdiga dokumentationen.

info

Note: Endast filer som uppfyller kriterierna för format som stöds är tillgängliga för dokumentationsgenerering. Se avsnittet Översikt för en fullständig lista över kompatibla filtyper och format.

Factory Agent för kodjämförelse (förhandsversion)​

Börja med att välja det projekt vars versionsskillnader du vill jämföra i huvudprojektlistan. Klicka på önskat projekt för att öppna dess detaljvy och tillgängliga dokumentationsalternativ och välj 2 versioner att jämföra. Välj därefter "Compare Versions" för att öppna verktyget för versionsjämförelse.

Välj i projektvyn ett element som visar skillnader. Vanligtvis är dessa element blå (ändrade), gröna (tillagda) eller röda (borttagna) – vitt innebär ingen förändring. När jämförelsevyn visas väljer du "Explain" i det block där du vill se en förklaring av skillnaden. Förklaringen av skillnaden visas under blocket.

Detaljnivåer för dokumentation​

Som standard genererar systemet utförlig dokumentation som ger omfattande analys med detaljerade förklaringar och djupgående täckning. Användare kan dock växla till den sammanfattade versionen om de föredrar en mer koncis översikt.

  • Utförlig: Ger detaljerade förklaringar, omfattande analys och djupgående täckning (standard)
  • Sammanfattad: Ger väsentlig information och nyckelbegrepp i komprimerat format