( viraghj | 2021. 02. 12., p – 20:35 )

A kibicnek semmi sem drága...

Az eddigi hozzászólások kimondva-kimondatlanul arra koncentráltak, hogy milyen eszközökkel legkönnyebb elkészíteni a dokumentációt. Ok, a Markdown alapú megoldások lehetnek faék egyszerűségűek, 5 perc alatt megtanulhatók.

De ha komolyabb dokumentációról van szó, nem árt különféle jegyzékeket, indexeket készíteni (pl. tartalomjegyzék, ábrajegyzék, algoritmusok jegyzéke, irodalomjegyzék, szójegyzék, stb.) meg tisztességes (kereszt)hivatkozásokat betenni a dokumentumokba. LaTeX alapon ez nem nagy kunszt, de nem tudom, hogyan segítene pl. ebben  a Markdown...

Arra is kíváncsi lennék pl. hogyan lehetne két forráskód listát egymás mellett formázva megjeleníteni - ami egy dokumentáció készítése közben éppenséggel reális igény lehet.

Szóval az egy pozitívum, hogy a Markdown-ba lehet LaTeX-et beágyazni, no de akkor miért ne legyen csak LaTeX?

Ha meg komolyan vesszük az első követelményt:

"Annyira részletes dokumentációt kellene írni, ami alapján egy olyan programozó is meg tudja csinálni a feladatot, aki nem érti az egész rendszert és a környezetet sem biztos hogy ismeri."

akkor lehet, hogy a "literate programming" filozófia szerint olyan eszközöket kellene használni, amikkel precízen leírható a kód és a dokumentáció kapcsolata, illetve közös forrásból generálható a kód és a dokumentáció.