Szoftver dokumentáció
2005-04-26T09:10:31+02:00
2005-04-26T09:43:01+02:00
2022-07-19T05:44:54+02:00
  • ha jól veszem ki a szavaidból, fejlesztői dokumentációt kell készítened

    azt nem írtad, hogy egy továbbfejlesztendő programhoz kell írnod, vagy szakdolgozathoz, de nagyjából így szokott kinézni:

    1. Fogalmazd meg, hogy mit csinál a program, miért készült, mire jó (amolyan rövidített specifikáció féle - bár lehet teljes spec. is, ha a szakdogába nem kell külön ilyet írni - már ha szakdogáról van szó)

    2. Képernyőképek, magyarázattal (itt nem a használatra kell kitérni, hanem a technikai részletekre, a vezérlők eseményeire, amit pár szóban elmagyarázol, hogy mi történik az adott esemény során). Itt le lehet írni azt is, hogy melyik vezérlő pontosan milyen komponens

    3. Ha használsz saját eljárásokat/függvényeket, akkor azok működésének részletesebb ismertetése

    4. Ha az adatbázisban nem úgy vannak letárolva az adatok, mint ahogy azokat felhasználod, akkor azok átalakításának menetéről is kell pár szót ejteni

    5. Az esetlegesen ismert problémák ismertetése, hogy egy adott dolgot miért úgy oldottál meg, ahogy, és miért nem jó úgy, hogy te is gondoltad először (pl. D5-ben a DBGrid nem tud scrollozni, így azt külön komponenssel kell megoldani (ami ugyanúgy néz ki, mint a DBGrid)); ide tartozhat még az is, ha a fejlesztőkörnyezet hibája miatt nem lehet valamit megoldani és azért maradt ki a programból

    6. Ugyanígy ha használsz külső komponenseket, akor azok használatáról egy rövid ismertető, a fellelési helyük és a részletes használatot elmagyarázó dokra való utalás

    7. Ahogy te is írtad, továbbfejlesztési lehetőségek, mi az, ami megrendelés/idő hiányában nem került bele a programba

    8. Speciális technikai részletek megoldásának ismertetése is lényeges dolog (pl. gondolok itt arra, hogy ha egy számlázó programot kell írnod, akkor ott ugye van egy követelményrendszer, hogy sorszámozás biztosítása, visszaszámlázás "tiltása", stornó, helyesbítés, stb., ezeket hogyan oldottad meg, persze ezt is szép kerek mondatokkal leírva)

    A magyarázó szövegek mellé tehetsz kódot is, de ne a kódról szóljon a doksi, hanem a fejlesztés technikai oldaláról, lényegében arról, hogy mit-hogyan-miért. Ha kódot írsz bele, akkor az mellett mindig legyen magyarázat, hogy melyik rész mit csinál, stb.

    Most úgy hirtelnjében ennyi, majd mások kiegészítik.

    Azért is kérdeztem, hogy mihez kell a doksi, mert ha magadnak írod a későbbiekhez, akkor lehet dolgokat egyszerűsíteni, ha másnak (pl. szakdoga), akkor érthetően kell megírni, mert lehet, hogy a szakdogát egy programozáshoz nem értő ember fogja elolvasni (nálunk pl. így volt).

    Üdv: Dr. Watson
    Mutasd a teljes hozzászólást!
  • Sziasztok

    Egy programhoz kellene készítenem egy dokumentációt(mi a prg. hogy működik, hogyan lehet tovább fejleszteni stb). Egyszóval egy elég részletes valamit kellene írnom. A problémám az, hogy még sohasem kellettt ilyen részletes dokumentációt írnom egy prg-hoz, és éppen ezért nem is tudom, hogy mik az elvásársok, a sablonok, stb.

    Tehát azt szeretném kérni,hogy legyetek szívesek, valami mankót írni a számomra, amivel el tudok indulni, vagy ha valaki tud mutatni egy sablont az maga lenne a csoda. Előre is köszönöm mindenkinek aki próbál segíteni.
    Mutasd a teljes hozzászólást!
abcd