Dokumentacija - matejbizjak/TrapIT GitHub Wiki
Uvod
Vedno bolj, ko programiram za za projekt, ugotavljam zakaj ljudje pišejo dokumentacijo. Moje mnenje je, da nam bo pisanje neke generalne dokumentacije zelo pomagalo. Zakaj? Splošno boljše je samo programiranje, kot ugotavljanje kako kateri del kode, ki je že napisan, deluje. Že tako ali tako so nekatere napisane funkcije težko razumljive na prvo oko, ugotavljanje kaj nek del kode dela pa vzame čas in voljo, pogovore imamo samo preko Discorda (vprašljivo, saj nikoli nismo vedno vsi prisotni).
Prednosti:
- hitra pregled dokumentacije ti okvirno predstavi kaj neki del kode dela (karkoli pač je),
- zaradi preglednosti dokumentacije, se spodbuja reciklaža obstoječe kode (brez pregleda kode 👍 ),
- vzame samo 5-minut pisanja, pridobitek pa je velik
- enostavno lahko predstaviš, kaj nek del kode dela
- (npr. ne boš za vsako funkcijo aplikacije delal svoje kode za api klice, ampak boš mogoče uporabil od koga drugega, ki je že to naredil)
Kaj narediti:
- opredeli kaj si v kodo dodal v spodnje kategorije,
- kratko opiši kaj in zakaj,
- kaj delajo/vračajo funkcije znotraj kategorje
Vodilo:
- probajmo sloneti k modularnosti, vso kode ki jo naredimo (uporabnost, vsakega specifičnega dela naj bo prenosljiva)
- ni potrebno dokumentirati vsega, samo tisto kar mislite, da bi prišlo prav komu drugem v skupini(ali za razlago, ali za funkcionalnost)
P.S "Koda do zdaj je super, brez problema ampak v prihodnje, bi bilo to super. Dokumentiranje je zgolj napotek, ni potrebno, samo bi nam pomagalo." - Miha