LogicDocs työkalut

Logiikan luonti ja tallennus työkalut

Kehitämme jatkuvasti erilaisia työkaluja logiikan automaattiseen dokumentointiin. Tällä hetkellä toteutukset ovat keskittyneet lähinnä datan keräämiseen graphviz dot tiedostojen automaattiseen luontiin IT toteutuksissa. Nämä työkalut voi jakaa karkeasti seuraaviin osa-alueisiin

• "Ison kuvan" luonti dokumentteihin ja/tai koodiin tehtyjen kommenttien pohjalta. Tämä edellyttää "node siirtymien" manuaalista kirjoittamista dokumentteihin ja/tai koodiin.
• Java sovellusten suoritus logiikan (metodi kutsujen) dokumentointi automaattisesti koodia muuttamatta (javaagent)
• Javascript sovellusten metodien suoritus logiikan dokumentointi. Tämän tiedon keräämiseksi on mahdollista käyttää console.trace() tai Error().stack menetelmiä. Kerätty tieto pitää prosessoida, jotta siitä voidaan muodostaa vuokaavio kuvia.
• REST API  client kutsujen ja server vastausten tallentaminen proxy:n avulla esim. tietokantaan. Proxy sijaitsee client ja server sovellusten välissä. Tämä ei edellytä koodimuuoksia. Client sovellus on vain konfiguroitava käyttämään proxy:ä serverin sijaan.
• Sovelluslogiikan toteuttaminen "flowchart" mallilla. Tämä soveltuu uusiin toteutuksiin/kokonaisuuksiin tai edellyttää todennäköisesti isoja koodimuutoksia.
• jne.

Yllä on muutama malli, jolla saamme luotua olemassaolevasta joko ilman isompaa työtä (java sovellusten javaagent) tai olemassa olevaan "kommentteja lisäämällä" automaattisesti logiikka kaavioita. Olemme ohjelmoijia ja kekseliäitä, joten oletan, että löydämme mallin dokumentoida myös teidän tarpeet LogicDocs ideologian mukaisesti vuokaavio mallilla.