Google Translate

Hungarian English French German Italian Portuguese Russian Spanish

Dokumentáció készítés

Jó esetben a forráskód elég egyértelmű neveket használ, és a működést leíró megjegyzéseket is tartalmaz. A leírás ne a kód lefordítása legyen, hanem arról szóljon mi fog most történni, és miért... Ha ezeket betartod, a forráskód részben egy dokumentációja is a programnak.

Ne szorítkozz csak a forráskódra. Még mielőtt egy sor kódot is jegyzettömbbe vetnél, nyiss egy szövegszerkesztőt, írd fel a projekt nevét, és kezd el szavakkal, ábrákkal leírni, hogy mik az elképzeléseid.

  • A megvalósítás programnyelve, fejlesztői környezet kiválasztása. Sokmindent befolyásol a többi pontban.
  • Mit kell tudnia a programnak, és hogyan fogja azt elvégezni?
  • Az egyes adatok honnan jönnek, hol tárolod, miképp változhatnak?
  • A program logikát legjobb folyamatábrán bemutatni.
  • Milyen (akár projekt specifikus) fájl formátumokat kell a szoftvernek kezelni? Formátumok leírása.
  • Milyen környezetben fog futni, minimális konfiguráció? (elején csak tipp, irányadás)
  • Ha az operációs rendszer függvényeire hagyatkozik a program, ügyelni kell rá, hogy minél több verzióban használható legyen. Terv.
  • Minden más amit fontosnak tartasz, és később úgy érzed szükséges információ lehet, írd le.
  • Döntsd el szeretnél -e verziókövető szoftvert használni a fejlesztés során (SVN). Nagy, komplex ill. sűrűn változó követelmények esetén erősen ajánlott. Akkor is nagyon hasznos ha több személy vesz részt a fejlesztési projekten - mivel lekövethető ki, mikor mit módosított. Továbbá korlátozható vele, hogy a forrás mely részét láthatják az egyes fejlesztők.
  • Hányan fognak részt venni a projekten? A személyek szerepének, feladatának, felelősségének a tisztázása.

A dokumentumot készítsd a kedvenc szövegszerkesztődben, és mentsd el a neki kényelmes formátumban, de őrizz róla egy html változatot is, hogy könnyebben megoszd másokkal.

Először ne használj stílusokat a bekezdések számára, eleinte csak papírra veted az ötleteidet. Ezt a lépést elkezdheted jegyzettömbben is. Később rendezd őket nagyobb csoportokba, adj címet a fejezeteknek. Érdemes a fejezeteket is több részre bontani, de nem feltétlenül szükséges. Ekkor már készíthetsz stílust, pl a fejezet címsorának, a "normal" bekezdéseknek, és opcionálisan az al-fejezetek, al-bekezdéseknek. A Webre optimalizáld a megjelenést, és ne vidd túlzásba, ez csak egy jól-kinéző dokumentáció. A felhasználói kézikönyvnek jobban kell kinéznie.


Példa egy egyszerű (darkbasic pro) projekt, egyszerű dokumentációjára:
Példa letöltése
Példa letöltése

Futtatható program letöltése

Cikk kiegészítve: 2010 Október !

Zene

Google keresés

Váltó

Digitális Táregység


Számrendszer

#=

IMDb Keresés

Kód

Karakter

Szín

Szín kódtábla

Webmaster: GoobeMaster
Érvényes XHTML és CSS
Minden jog fenntartva! ® 2010 - 2017
Jogtulajdonos: United Voxels Ltd. (United Kingdom)

Check Google Page Rank

Technikai háttér: