A
A
  • Angol
  • Magyar
  • 8 perc

Codumentation és a jövő dokumentációja: Hogyan igazolják kódok az állításokat?

A modern fejlesztés egyik legnagyobb kihívása a naprakész dokumentáció. Erre kínál forradalmi megoldást a Codumentation, amely minden dokumentációs állítást kóddal igazol.

A részletes bemutatóban a fejlesztők gyakori problémáját helyezi középpontba: hogyan válik a dokumentáció egy idő után elavulttá és megbízhatatlanná. Érdekes kérdéseket vet fel arról, hogy a statikus leírások mennyire támaszkodnak „reményalapú” frissességre, vagyis arra, hogy valaki hibát talál, ha az információ már nem pontos.

Felhívja a figyelmet arra, hogy a mesterséges intelligenciára támaszkodó fejlesztői eszközök mennyire sérülékenyek a hibás dokumentáció miatt, hiszen ezek az eszközök automatikusan követik a dokumentumban írtakat – akkor is, ha a valóságnak már nem felelnek meg.

Egy új eszköz, a Codumentation működését mutatja be: ez a program képes arra, hogy a dokumentáció minden állítását kódalapú tesztekkel igazolja, így automatikusan ellenőrzi, hogy a dokumentáció állításai megfelelnek-e a tényleges kódnak. Konkrét példán keresztül is bemutatja, hogyan lehet a Codumentation segítségével egy NodeJS projektben élő és folyamatosan igazolt dokumentációt létrehozni.

Felmerül annak lehetősége is, hogyan válik a dokumentáció alkalmazható, szerződésféle biztosítékká, amit CI/CD folyamatokba integrálva akár automatikusan is ellenőrizhetünk minden fejlesztési ciklusban.