Fogalomtár › Fejlesztői alapszavak
dokumentáció
angolul: documentation
A dokumentáció egy szoftverhez tartozó írott leírás: elmondja, mire való a program, hogyan kell használni, és hogyan épül fel belülről.
Érthetően
A dokumentáció a szoftver használati útmutatója és tervrajza egyben. Olyan, mint a mosógéphez adott kezelési könyv és a ház tervrajza együtt: az egyik megmutatja, melyik gombot nyomd meg, a másik azt, hol futnak a falban a vezetékek.
Többféle olvasónak készül. A felhasználó azt keresi benne, hogyan érje el, amit szeretne; a fejlesztő azt, hogyan kapcsolhatja össze a programot egy másikkal; az üzemeltető azt, mit tegyen, ha valami elromlik.
Az AI korában új olvasója is lett: a gép. Egy kódoló agent ugyanúgy a leírásokból tájékozódik, mint egy új kolléga, ezért ma már kifejezetten agenteknek szánt útmutatók is készülnek, amelyek elmondják, mik egy projekt szabályai és hogyan kell benne dolgozni.
Ami megkülönbözteti magától a programtól: a kód azt rögzíti, mit csinál a gép, a dokumentáció pedig azt, hogy miért, és hogyan érdemes használni. Jó program is lehet használhatatlan, ha senki nem tudja, hogyan kell bánni vele.
Hogyan működik
- A készítők leírják, mire való a szoftver, és hogyan lehet elindítani; ez többnyire egy rövid bemutatkozó fájl, a README.
- Ehhez különböző célú anyagok társulnak: lépésről lépésre vezető oktatóanyag, feladatmegoldó útmutató, pontos referencia a funkciókról és háttérmagyarázat a döntésekről.
- A leírást sokszor a kód mellett, ugyanott tárolják és ugyanúgy verziózzák, így követhető, melyik szöveg melyik programváltozathoz tartozik.
- A referencia egy részét programok állítják elő a kódba írt megjegyzésekből, a szöveget pedig egyre gyakrabban AI segítségével fogalmazzák meg, amit embernek kell ellenőriznie.
- Az AI-agent munka közben beolvassa a leírásokat, és ezek alapján is dönti el, melyik eszközt hogyan használja; ha a leírás pontatlan, az agent is könnyen hibázik.
Példa a mindennapokból
Új számlázóprogramot vezettek be a munkahelyeden, és nem találod, hogyan kell sztornózni egy számlát. Megnyitod a súgót, vagy megkérdezed a program beépített AI-asszisztensét; jó esetben a válasz mindkét esetben a dokumentációra támaszkodik. Ha az elavult, a rossz gombra fog küldeni.
Kit érint
Gyakori félreértés
Korlátok és kockázatok
- A dokumentáció könnyen elavul: a program változik, a leírás marad, és a régi útmutató rosszabb lehet, mint a hiányzó.
- Az AI által generált leírás hihetően hangzik akkor is, ha nem létező funkciót vagy rossz beállítást ír le, ezért mindig vesd össze a valósággal.
- Az agent a leírtakat utasításként követheti, így egy hibás vagy rosszindulatúan megírt dokumentum rossz lépésekre is ráveheti.
- A sok szöveg nem jelent jó dokumentációt: ha nem találod meg benne gyorsan a választ, nem tölti be a szerepét.
Hasonló, de nem ugyanaz
- kódkomment – A komment a kód egy-egy részéhez fűzött rövid megjegyzés, a dokumentáció viszont önállóan olvasható, a program egészét bemutató anyag.
- specifikáció – A specifikáció előre rögzíti, minek kell elkészülnie, a dokumentáció azt írja le, ami elkészült, és hogyan kell használni.
- prompt – A prompt egy adott feladatra szóló, pillanatnyi utasítás az AI-nak, a dokumentáció tartós, többször felhasznált tudásanyag.
Kapcsolódó fogalmak
szoftverfejlesztés, tudásmenedzsment
README, API-dokumentáció, felhasználói kézikönyv, műszaki dokumentáció
kódtár, verziókezelés, API, kódoló agent, kontextus
Röviden a története
A szoftverdokumentáció egyidős a programozással: a számítógépekhez kezdettől nyomtatott kézikönyveket adtak. Az internet elterjedésével a leírások a webre költöztek, a nagy nyelvi modellek megjelenése óta pedig gépi olvasóknak is készülnek.
Hol tart most
2026 végén a dokumentáció a szoftverfejlesztés magától értetődő része, és két irányban változik: egyre nagyobb részét AI segítségével írják, és egyre több készül kifejezetten agentek számára. A minősége erősen befolyásolja, mennyire megbízhatóan dolgoznak az agentek.
A hírekben
- Az athenahealth lehetővé teszi, hogy a betegek a Claude-dal kérdezzenek az egészségügyi adataikról2026. nov. 2. · Egészség
- AI-írnokok időt takarítanak meg, de nem oldják meg az orvosi kiégést2026. okt. 20. · Egészség
- Az Anthropic benyújtotta az IPO-prospektust, a történelem egyik legnagyobb bevezetésére készül2026. okt. 19. · Agent Age
- Az AI-pilotokból gyári döntések kellenek: a hibafelismeréstől a cselekvésig2026. okt. 12. · Ipar
- A VA 775 millió dolláros szerződésben tesz ambient AI-t a klinikai dokumentációba2026. szept. 28. · Egészség
- Tanulmányok: AI-jegyzetelés csökkentheti az orvosok és ápolók dokumentációs terhét2026. szept. 22. · Egészség
- GPAI-gyakorlati kódex átláthatósági fejezete és bizottsági iránymutatás2026. szept. 19. · Jog
- Kutatások szerint az AI-jegyzetelők csökkentik az orvosok dokumentációs idejét és kiégését2026. szept. 15. · Egészség
Más nevei
dokumentáció · documentation · docs · doksi · szoftverdokumentáció · software documentation · műszaki dokumentáció · technical documentation
Források
A szócikk gépi szerkesztéssel készült és gépi szakmai lektoráláson ment át; a „hírekben” rész az Agent Age sztorijaiból automatikusan frissül.